Field Detail

• VARIABLE_DECLARATIONS_LIST

  public static final String VARIABLE_DECLARATIONS_LIST

  Notifies the content of the list of VariableDeclarationStateObject has changed.

  See Also:

  Constant Field Values

Method Detail

• addCollectionDeclaration

  public CollectionMemberDeclarationStateObject addCollectionDeclaration()

  Adds a new collection declaration to the FROM clause.

  Returns:

  The CollectionMemberDeclarationStateObject representing the collection declaration

• addCollectionDeclaration

  public CollectionMemberDeclarationStateObject addCollectionDeclaration​(String collectionValuedPath,
                                                                         String identificationVariable)

  Adds a new collection declaration to the FROM clause.

  Parameters:

  collectionValuedPath - The collection-valued path expression

  identificationVariable - The variable defining the collection-valued path expression

  Returns:

  The CollectionMemberDeclarationStateObject representing the collection declaration

• addRangeDeclaration

  public IdentificationVariableDeclarationStateObject addRangeDeclaration()

  Adds a new range variable declaration to the FROM clause.

  Returns:

  The StateObject representing the range variable declaration

• addRangeDeclaration

  public IdentificationVariableDeclarationStateObject addRangeDeclaration​(IEntity entity,
                                                                          String identificationVariable)

  Adds to this select statement a new range variable declaration.

  Parameters:

  entity - The external form of the entity to add to the declaration list

  identificationVariable - The unique identifier identifying the abstract schema name

  Returns:

  The state object of the new declaration

• addRangeDeclaration

  public IdentificationVariableDeclarationStateObject addRangeDeclaration​(String entityName,
                                                                          String identificationVariable)

  Adds a new range variable declaration.

  Parameters:

  entityName - The name of the entity name

  identificationVariable - The new identification variable

  Returns:

  The state object of the new declaration

• declarations

  public ListIterable<? extends VariableDeclarationStateObject> declarations()

  Returns the list of declarations declared in the declaration clause of the current query.

  Specified by:

  declarations in interface DeclarationStateObject

  Returns:

  The list of VariableDeclarationStateObject that define the domain of the query

• findIdentificationVariable

  public IdentificationVariableStateObject findIdentificationVariable​(String variable)

  Returns the IdentificationVariableStateObject representing the given identification variable.

  Specified by:

  findIdentificationVariable in interface StateObject

  Overrides:

  findIdentificationVariable in class AbstractStateObject

  Parameters:

  variable - The name of the identification variable to retrieve its state object

  Returns:

  The IdentificationVariableStateObject defining the given identification variable

• getDeclaration

  public DeclarationStateObject getDeclaration()

  Returns the declaration clause which defines the domain of the query by declaring identification variables.

  Specified by:

  getDeclaration in interface StateObject

  Overrides:

  getDeclaration in class AbstractStateObject

  Returns:

  The declaration clause of which this StateObject is a child; i.e. either the top-level declaration if this is part of the top query or the sub-level declaration if this is part of a subquery

• getExpression

  public AbstractFromClause getExpression()

  Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

  Specified by:

  getExpression in interface StateObject

  Overrides:

  getExpression in class AbstractStateObject

  Returns:

  The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)

• getManagedType

  public IManagedType getManagedType​(StateObject stateObject)

  Returns the IManagedType for the given identification variable. The search does not traverse up the query hierarchy if this declaration is for a subquery.

  SELECT e FROM Department d JOIN KEY(d.employees).addresses a

  In the above query, the managed type associated with the identification variable:

  • d is "Department"
  • a is "Address"

  Specified by:

  getManagedType in interface DeclarationStateObject

  Parameters:

  stateObject - The StateObject that should be an simple identification variable or an encapsulated identification variable with the identifier KEY or VALUE

  Returns:

  The IManagedType representing the domain object declared by the given identification variable

  See Also:

  DeclarationStateObject.findManagedType(StateObject)

• getParent

  public AbstractSelectStatementStateObject getParent()

  Returns the parent of this StateObject.

  Specified by:

  getParent in interface StateObject

  Overrides:

  getParent in class AbstractStateObject

  Returns:

  Returns the parent of this StateObject, which is null only when this is the root of the hierarchy

• identificationVariables

  public Iterable<IdentificationVariableStateObject> identificationVariables()

  Returns the IdentificationVariableStateObjects holding onto the identification variables, which are the variables defined in the FROM clause.

  Example:

  • Employee e; e is returned
  • IN (e.employees) AS emps; emps is returned
  • Manager m JOIN m.employees emps; m and emps are returned

  Returns:

  The list of IdentificationVariableStateObjects

• isEquivalent

  public boolean isEquivalent​(StateObject stateObject)

  Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

  Specified by:

  isEquivalent in interface StateObject

  Overrides:

  isEquivalent in class AbstractStateObject

  Parameters:

  stateObject - The StateObject to compare its content to this one

  Returns:

  true if both object are equivalent; false otherwise

• parse

  public void parse​(String jpqlFragment)

  Parses the given JPQL fragment and create the select item. For the top-level query, the fragment can contain several select items but for a subquery, it can represent only one.

  Parameters:

  jpqlFragment - The portion of the query representing one or several select items