EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.jpql
Enum AbstractContentAssistVisitor.IdentificationVariableType

java.lang.Object
  extended by java.lang.Enum<AbstractContentAssistVisitor.IdentificationVariableType>
      extended by org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.IdentificationVariableType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AbstractContentAssistVisitor.IdentificationVariableType>
Enclosing class:
AbstractContentAssistVisitor

protected static enum AbstractContentAssistVisitor.IdentificationVariableType
extends java.lang.Enum<AbstractContentAssistVisitor.IdentificationVariableType>

The various ways of retrieving identification variables from the declaration expression.


Enum Constant Summary
ALL
          Retrieves all the identification variables declared in the declaration portion of the expression, which is either in the FROM clause of a SELECT query or DELETE query or in the UPDATE query.
COLLECTION
          Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression.
LEFT
          Only retrieves the identification variables that have been declared to the left of the expression requested them, both range and collection type variables are collected.
LEFT_COLLECTION
          Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression but that have been declared to the left of the expression requested them.
NONE
          Simply indicate the identification variables should not be collected.
RESULT_VARIABLE
          Retrieves the result variables that have been defined in the SELECT clause.
 
Method Summary
static AbstractContentAssistVisitor.IdentificationVariableType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AbstractContentAssistVisitor.IdentificationVariableType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ALL

public static final AbstractContentAssistVisitor.IdentificationVariableType ALL
Retrieves all the identification variables declared in the declaration portion of the expression, which is either in the FROM clause of a SELECT query or DELETE query or in the UPDATE query.


COLLECTION

public static final AbstractContentAssistVisitor.IdentificationVariableType COLLECTION
Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression.


LEFT

public static final AbstractContentAssistVisitor.IdentificationVariableType LEFT
Only retrieves the identification variables that have been declared to the left of the expression requested them, both range and collection type variables are collected.


LEFT_COLLECTION

public static final AbstractContentAssistVisitor.IdentificationVariableType LEFT_COLLECTION
Only retrieves the identification variables that map a path expression defined in a JOIN expression or in a IN expression but that have been declared to the left of the expression requested them.


NONE

public static final AbstractContentAssistVisitor.IdentificationVariableType NONE
Simply indicate the identification variables should not be collected.


RESULT_VARIABLE

public static final AbstractContentAssistVisitor.IdentificationVariableType RESULT_VARIABLE
Retrieves the result variables that have been defined in the SELECT clause.

Method Detail

values

public static AbstractContentAssistVisitor.IdentificationVariableType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AbstractContentAssistVisitor.IdentificationVariableType c : AbstractContentAssistVisitor.IdentificationVariableType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AbstractContentAssistVisitor.IdentificationVariableType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference