EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractFromClauseStateObject

Modifier and Type	Field and Description
public static final String	VARIABLE_DECLARATIONS_LIST Notifies the content of the list of `VariableDeclarationStateObject` has changed.

Access	Constructor and Description
protected	AbstractFromClauseStateObject(AbstractSelectStatementStateObject The parent of this state object, which cannot be `null` parent) Creates a new `AbstractFromClauseStateObject`.

Method Summary

Modifier and Type	Method and Description
public CollectionMemberDeclarationStateObject	Returns: The `CollectionMemberDeclarationStateObject` representing the collection declaration addCollectionDeclaration() Adds a new collection declaration to the `FROM` clause.
public CollectionMemberDeclarationStateObject	Returns: The `CollectionMemberDeclarationStateObject` representing the collection declaration addCollectionDeclaration(String The collection-valued path expression collectionValuedPath, String The variable defining the collection-valued path expression identificationVariable) Adds a new collection declaration to the `FROM` clause.
protected void	addProblems(List<Problem> The list to which the problems are added currentProblems) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addProblems. Adds to the given list the problems that were found with the current state of this `StateObject`, which means there are validation issues.
public IdentificationVariableDeclarationStateObject	Returns: The `StateObject` representing the range variable declaration addRangeDeclaration() Adds a new range variable declaration to the `FROM` clause.
public IdentificationVariableDeclarationStateObject	Returns: The state object of the new declaration addRangeDeclaration(IEntity The external form of the entity to add to the declaration list entity, String The unique identifier identifying the abstract schema name identificationVariable) Adds to this select statement a new range variable declaration.
public IdentificationVariableDeclarationStateObject	Returns: The state object of the new declaration addRangeDeclaration(String The name of the entity name entityName, String The new identification variable identificationVariable) Adds a new range variable declaration.
protected abstract String	Returns: The BNF of the declaration part of this clause declarationBNF() Returns the BNF of the declaration part of this clause.
public ListIterable<? extends VariableDeclarationStateObject>	declarations() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Returns the list of declarations declared in the declaration clause of the current query.
public IdentificationVariableStateObject	findIdentificationVariable(String The name of the identification variable to retrieve its state object variable) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.findIdentificationVariable. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.findIdentificationVariable. Returns the `IdentificationVariableStateObject` representing the given identification variable.
public DeclarationStateObject	getDeclaration() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getDeclaration. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Returns the declaration clause which defines the domain of the query by declaring identification variables.
public AbstractFromClause	getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
public IManagedType	getManagedType(StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. Returns the `IManagedType` for the given identification variable.
public AbstractSelectStatementStateObject	getParent() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getParent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Returns the parent of this `StateObject`.
public Iterable<IdentificationVariableStateObject>	Returns: The list of `IdentificationVariableStateObjects` identificationVariables() Returns the `IdentificationVariableStateObjects` holding onto the identification variables, which are the variables defined in the `FROM` clause.
public boolean	isEquivalent(StateObject The `StateObject` to compare its content to this one stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same.
protected String	listName() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Returns the name that is uniquely identifying the list.
public void	parse(String The portion of the query representing one or several select items jpqlFragment) Parses the given JPQL fragment and create the select item.
protected void	toTextInternal(Appendable The writer used to print out the string representation writer) Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject:: addChildren addItem addItems addListChangeListener areChildrenEquivalent canMoveDown canMoveUp getItem hasItems initialize items itemsSize moveDown moveUp removeItem removeItems removeListChangeListener toStringItems

VARIABLE_DECLARATIONS_LIST	back to summary
public static final String VARIABLE_DECLARATIONS_LIST Notifies the content of the list of `VariableDeclarationStateObject` has changed.

AbstractFromClauseStateObject	back to summary
protected AbstractFromClauseStateObject(AbstractSelectStatementStateObject parent) Creates a new `AbstractFromClauseStateObject`. Parameters parent:AbstractSelectStatementStateObject The parent of this state object, which cannot be `null` Exceptions NullPointerException: The given parent cannot be `null`

Method Detail

addCollectionDeclaration back to summary

addCollectionDeclaration	back to summary
public CollectionMemberDeclarationStateObject addCollectionDeclaration() Adds a new collection declaration to the `FROM` clause. Returns:CollectionMemberDeclarationStateObject The `CollectionMemberDeclarationStateObject` representing the collection declaration

public CollectionMemberDeclarationStateObject addCollectionDeclaration()

Adds a new collection declaration to the FROM clause.

Returns:CollectionMemberDeclarationStateObject: The CollectionMemberDeclarationStateObject representing the collection declaration

addCollectionDeclaration back to summary

addCollectionDeclaration	back to summary
public CollectionMemberDeclarationStateObject addCollectionDeclaration(String collectionValuedPath, String identificationVariable) Adds a new collection declaration to the `FROM` clause. Parameters collectionValuedPath:String The collection-valued path expression identificationVariable:String The variable defining the collection-valued path expression Returns:CollectionMemberDeclarationStateObject The `CollectionMemberDeclarationStateObject` representing the collection declaration

public CollectionMemberDeclarationStateObject addCollectionDeclaration(String collectionValuedPath, String identificationVariable)

Adds a new collection declaration to the FROM clause.

Parameters

collectionValuedPath:String: The collection-valued path expression
identificationVariable:String: The variable defining the collection-valued path expression

Returns:CollectionMemberDeclarationStateObject

The CollectionMemberDeclarationStateObject representing the collection declaration

addProblems back to summary

addProblems	back to summary
protected void addProblems(List<Problem> currentProblems) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addProblems. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addProblems. Adds to the given list the problems that were found with the current state of this `StateObject`, which means there are validation issues. Parameters currentProblems:List<Problem> The list to which the problems are added Annotations @Override

protected void addProblems(List<Problem> currentProblems)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addProblems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addProblems.

Adds to the given list the problems that were found with the current state of this StateObject, which means there are validation issues.

Parameters

currentProblems:List<Problem>: The list to which the problems are added

Annotations

@Override

addRangeDeclaration back to summary

addRangeDeclaration	back to summary
public IdentificationVariableDeclarationStateObject addRangeDeclaration() Adds a new range variable declaration to the `FROM` clause. Returns:IdentificationVariableDeclarationStateObject The `StateObject` representing the range variable declaration

public IdentificationVariableDeclarationStateObject addRangeDeclaration()

Adds a new range variable declaration to the FROM clause.

Returns:IdentificationVariableDeclarationStateObject: The StateObject representing the range variable declaration

addRangeDeclaration	back to summary
public IdentificationVariableDeclarationStateObject addRangeDeclaration(IEntity entity, String identificationVariable) Adds to this select statement a new range variable declaration. Parameters entity:IEntity The external form of the entity to add to the declaration list identificationVariable:String The unique identifier identifying the abstract schema name Returns:IdentificationVariableDeclarationStateObject The state object of the new declaration

addRangeDeclaration

back to summary

public IdentificationVariableDeclarationStateObject addRangeDeclaration(IEntity entity, String identificationVariable)

Adds to this select statement a new range variable declaration.

Parameters

entity:IEntity: The external form of the entity to add to the declaration list
identificationVariable:String: The unique identifier identifying the abstract schema name

Returns:IdentificationVariableDeclarationStateObject

The state object of the new declaration

addRangeDeclaration	back to summary
public IdentificationVariableDeclarationStateObject addRangeDeclaration(String entityName, String identificationVariable) Adds a new range variable declaration. Parameters entityName:String The name of the entity name identificationVariable:String The new identification variable Returns:IdentificationVariableDeclarationStateObject The state object of the new declaration

addRangeDeclaration

back to summary

public IdentificationVariableDeclarationStateObject addRangeDeclaration(String entityName, String identificationVariable)

Adds a new range variable declaration.

Parameters

entityName:String: The name of the entity name
identificationVariable:String: The new identification variable

Returns:IdentificationVariableDeclarationStateObject

The state object of the new declaration

declarationBNF	back to summary
protected abstract String declarationBNF() Returns the BNF of the declaration part of this clause. Returns:String The BNF of the declaration part of this clause

declarationBNF

back to summary

protected abstract String declarationBNF()

Returns the BNF of the declaration part of this clause.

Returns:String: The BNF of the declaration part of this clause

declarations back to summary

declarations	back to summary
public ListIterable<? extends VariableDeclarationStateObject> declarations() Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations. Returns the list of declarations declared in the declaration clause of the current query. Returns:ListIterable<? extends VariableDeclarationStateObject> The list of `VariableDeclarationStateObject` that define the domain of the query Annotations @Override

public ListIterable<? extends VariableDeclarationStateObject> declarations()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.declarations.

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

Returns:ListIterable<? extends VariableDeclarationStateObject>

The list of VariableDeclarationStateObject that define the domain of the query

Annotations

@Override

findIdentificationVariable back to summary

findIdentificationVariable	back to summary
public IdentificationVariableStateObject findIdentificationVariable(String variable) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.findIdentificationVariable. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.findIdentificationVariable. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.findIdentificationVariable. Returns the `IdentificationVariableStateObject` representing the given identification variable. Parameters variable:String The name of the identification variable to retrieve its state object Returns:IdentificationVariableStateObject The `IdentificationVariableStateObject` defining the given identification variable Annotations @Override

public IdentificationVariableStateObject findIdentificationVariable(String variable)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.findIdentificationVariable.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.findIdentificationVariable.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.findIdentificationVariable.

Returns the IdentificationVariableStateObject representing the given identification variable.

Parameters

variable:String: The name of the identification variable to retrieve its state object

Returns:IdentificationVariableStateObject

The IdentificationVariableStateObject defining the given identification variable

Annotations

@Override

getDeclaration back to summary

getDeclaration	back to summary
public DeclarationStateObject getDeclaration() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getDeclaration. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration. Returns the declaration clause which defines the domain of the query by declaring identification variables. Returns:DeclarationStateObject 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 Annotations @Override

public DeclarationStateObject getDeclaration()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getDeclaration.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getDeclaration.

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

Returns:DeclarationStateObject

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

Annotations

@Override

getExpression back to summary

getExpression	back to summary
public AbstractFromClause getExpression() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression. Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query. Returns:AbstractFromClause 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) Annotations @Override

public AbstractFromClause getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getExpression.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

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

Returns:AbstractFromClause

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)

Annotations

@Override

getManagedType back to summary

getManagedType	back to summary
public IManagedType getManagedType(StateObject stateObject) Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType. 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" Parameters stateObject:StateObject The `StateObject` that should be an simple identification variable or an encapsulated identification variable with the identifier `KEY` or `VALUE` Returns:IManagedType The `IManagedType` representing the domain object declared by the given identification variable Annotations @Override

public IManagedType getManagedType(StateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.DeclarationStateObject.getManagedType.

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"

Parameters

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

Returns:IManagedType

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

Annotations

@Override

getParent back to summary

getParent	back to summary
public AbstractSelectStatementStateObject getParent() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getParent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent. Returns the parent of this `StateObject`. Returns:AbstractSelectStatementStateObject Returns the parent of this `StateObject`, which is `null` only when this is the root of the hierarchy Annotations @Override

public AbstractSelectStatementStateObject getParent()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.getParent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getParent.

Returns the parent of this StateObject.

Returns:AbstractSelectStatementStateObject

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

Annotations

@Override

identificationVariables back to summary

identificationVariables	back to summary
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:Iterable<IdentificationVariableStateObject> The list of `IdentificationVariableStateObjects`

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:Iterable<IdentificationVariableStateObject>: The list of IdentificationVariableStateObjects

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(StateObject stateObject) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent. Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent. Determines whether the given `StateObject` is equivalent to this one, i.e. the information of both `StateObject` is the same. Parameters stateObject:StateObject The `StateObject` to compare its content to this one Returns:boolean `true` if both object are equivalent; `false` otherwise Annotations @Override

public boolean isEquivalent(StateObject stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

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

Parameters

stateObject:StateObject: The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations

@Override

listName	back to summary
protected String listName() Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName. Returns the name that is uniquely identifying the list. Returns:String The unique name identifying the list Annotations @Override

listName

back to summary

protected String listName()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject.listName.

Returns the name that is uniquely identifying the list.

Returns:String

The unique name identifying the list

Annotations

@Override

parse	back to summary
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:String The portion of the query representing one or several select items

parse

back to summary

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:String: The portion of the query representing one or several select items

toTextInternal back to summary

toTextInternal	back to summary
protected void toTextInternal(Appendable writer) throws IOException Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal. Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes. Parameters writer:Appendable The writer used to print out the string representation Annotations @Override Exceptions IOException: This should never happens, it is only required because `Appendable` is used instead of any concrete class

protected void toTextInternal(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Parameters

writer:Appendable: The writer used to print out the string representation

Annotations

@Override

Exceptions

IOException:: This should never happens, it is only required because Appendable is used instead of any concrete class

public abstract Class AbstractFromClauseStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail