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

Modifier and Type	Field and Description
private AbstractFromClauseStateObject	fromClause The state object representing the `FROM` clause.
public static final String	GROUP_BY_CLAUSE_PROPERTY Notify the state object representing the `GROUP BY` clause has changed.
private GroupByClauseStateObject	groupByClause The state object representing the `GROUP BY` clause.
public static final String	HAVING_CLAUSE_PROPERTY Notify the state object representing the `HAVING` clause has changed.
private HavingClauseStateObject	havingClause The state object representing the `HAVING` clause.
private AbstractSelectClauseStateObject	selectClause The state object representing the `SELECT` clause.
public static final String	WHERE_CLAUSE_PROPERTY Notify the state object representing the `WHERE` clause has changed.
private WhereClauseStateObject	whereClause The state object representing the `WHERE` clause.

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

Method Summary

Modifier and Type	Method and Description
protected void	addChildren(List<StateObject> The list used to store the children children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list.
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.
public GroupByClauseStateObject	Returns: The `GroupByClauseStateObject` addGroupByClause() Adds the `GROUP BY` clause.
public GroupByClauseStateObject	Returns: The `GroupByClauseStateObject` addGroupByClause(String The fragment of the JPQL to parse that represents the group by items, the fragment cannot start with `GROUP BY` jpqlFragment) Adds the `GROUP BY` clause and parses the given JPQL fragment.
public HavingClauseStateObject	Returns: The `GroupByClauseStateObject` addHavingClause() Adds the `HAVING` clause.
public HavingClauseStateObject	Returns: The `HavingClauseStateObject` addHavingClause(String The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with `HAVING` jpqlFragment) Adds the `HAVING` clause and parses the given JPQL fragment.
public IdentificationVariableDeclarationStateObject	Returns: The `StateObject` representing the new range variable declaration addRangeDeclaration() Adds a new range variable declaration to the `FROM` clause.
public IdentificationVariableDeclarationStateObject	Returns: The `StateObject` representing the new range variable declaration addRangeDeclaration(IEntity The external form of the entity to add to the declaration list entity, String The unique identifier identifying the given `IEntity` identificationVariable) Adds to this select statement a new range variable declaration.
public IdentificationVariableDeclarationStateObject	Returns: The `StateObject` representing the range variable declaration addRangeDeclaration(String The name of the entity entityName, String The unique identifier identifying the entity identificationVariable) Adds to this select statement a new range variable declaration.
public WhereClauseStateObject	Returns: The `GroupByClauseStateObject` addWhereClause() Adds the `WHERE` clause.
public WhereClauseStateObject	Returns: The `WhereClauseStateObject` addWhereClause(String The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with `WHERE` jpqlFragment) Adds the `WHERE` clause and parses the given JPQL fragment.
protected abstract AbstractFromClauseStateObject	Returns: A concrete instance of `AbstractFromClauseStateObject` buildFromClause() Creates the state object representing the `FROM` clause.
protected abstract AbstractSelectClauseStateObject	Returns: A concrete instance of `AbstractSelectClauseStateObject` buildSelectClause() Creates the state object representing the `SELECT` clause.
public ListIterable<? extends VariableDeclarationStateObject>	Returns: The list of `VariableDeclarationStateObject` declarations() Returns the list of `VariableDeclarationStateObject` defining the variable declarations, which are mapping an entity to a variable or a collection-valued member to a variable.
public IdentificationVariableStateObject	findIdentificationVariable(String The name of the identification variable to retrieve its state object identificationVariable) 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 AbstractSelectStatement	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 AbstractFromClauseStateObject	Returns: The state object representing the `FROM` clause, which is never `null` getFromClause() Returns the state object representing the `FROM` clause.
public GroupByClauseStateObject	Returns: Either the actual state object representing the `GROUP BY` clause or `null` if it's not present getGroupByClause() Returns the state object representing the `GROUP BY` clause.
public HavingClauseStateObject	Returns: Either the actual state object representing the `HAVING` clause or `null` if it's not present getHavingClause() Returns the state object representing the `HAVING` clause.
public AbstractSelectClauseStateObject	Returns: Either the actual state object representing the `SELECT` clause, which is never `null` getSelectClause() Returns the state object representing the `SELECT` clause.
public WhereClauseStateObject	Returns: Either the actual state object representing the `WHERE` clause or the `null` state object since `null` is never returned getWhereClause() Returns the state object representing the `WHERE` clause.
public boolean	Returns: Either the actual state object representing the `GROUP BY` clause or `null` if it's not present hasGroupByClause() Returns the state object representing the `GROUP BY` clause.
public boolean	Returns: Either the actual state object representing the `HAVING` clause or `null` if it's not present hasHavingClause() Returns the state object representing the `HAVING` clause.
public boolean	Returns: Either the actual state object representing the `WHERE` clause or `null` if it's not present hasWhereClause() Returns the state object representing the `WHERE` clause.
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.
protected void	initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object.
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.
public void	parseSelect(String The portion of the query representing one or several select items jpqlFragment) Parses the given JPQL fragment and create the select item.
public void	removeGroupByClause() Removes the `GROUP BY` clause.
public void	removeHavingClause() Removes the `HAVING` clause.
public void	removeWhereClause() Removes the `WHERE` clause.
private void	setGroupByClause(GroupByClauseStateObject groupByClause)
private void	setHavingClause(HavingClauseStateObject havingClause)
private void	setWhereClause(WhereClauseStateObject whereClause)
public void	toggleGroupByClause() Either adds or removes the state object representing the `GROUP BY` clause.
public void	toggleHavingClause() Either adds or removes the state object representing the `HAVING` clause.
public void	toggleWhereClause() Either adds or removes the state object representing the `WHERE` clause.
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.

fromClause	back to summary
private AbstractFromClauseStateObject fromClause The state object representing the `FROM` clause.

GROUP_BY_CLAUSE_PROPERTY	back to summary
public static final String GROUP_BY_CLAUSE_PROPERTY Notify the state object representing the `GROUP BY` clause has changed.

groupByClause	back to summary
private GroupByClauseStateObject groupByClause The state object representing the `GROUP BY` clause.

HAVING_CLAUSE_PROPERTY	back to summary
public static final String HAVING_CLAUSE_PROPERTY Notify the state object representing the `HAVING` clause has changed.

havingClause	back to summary
private HavingClauseStateObject havingClause The state object representing the `HAVING` clause.

selectClause	back to summary
private AbstractSelectClauseStateObject selectClause The state object representing the `SELECT` clause.

WHERE_CLAUSE_PROPERTY	back to summary
public static final String WHERE_CLAUSE_PROPERTY Notify the state object representing the `WHERE` clause has changed.

whereClause	back to summary
private WhereClauseStateObject whereClause The state object representing the `WHERE` clause.

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

Method Detail

addChildren back to summary

addChildren	back to summary
protected void addChildren(List<StateObject> children) Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren. Adds the children of this `StateObject` to the given list. Parameters children:List<StateObject> The list used to store the children Annotations @Override

protected void addChildren(List<StateObject> children)

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

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

Adds the children of this StateObject to the given list.

Parameters

children:List<StateObject>: The list used to store the children

Annotations

@Override

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

addGroupByClause back to summary

addGroupByClause	back to summary
public GroupByClauseStateObject addGroupByClause() Adds the `GROUP BY` clause. The clause is not added if it's already present. Returns:GroupByClauseStateObject The `GroupByClauseStateObject`

public GroupByClauseStateObject addGroupByClause()

Adds the GROUP BY clause. The clause is not added if it's already present.

Returns:GroupByClauseStateObject: The GroupByClauseStateObject

addGroupByClause back to summary

addGroupByClause	back to summary
public GroupByClauseStateObject addGroupByClause(String jpqlFragment) Adds the `GROUP BY` clause and parses the given JPQL fragment. The clause is not added if it's already present. Parameters jpqlFragment:String The fragment of the JPQL to parse that represents the group by items, the fragment cannot start with `GROUP BY` Returns:GroupByClauseStateObject The `GroupByClauseStateObject`

public GroupByClauseStateObject addGroupByClause(String jpqlFragment)

Adds the GROUP BY clause and parses the given JPQL fragment. The clause is not added if it's already present.

Parameters

jpqlFragment:String: The fragment of the JPQL to parse that represents the group by items, the fragment cannot start with GROUP BY

Returns:GroupByClauseStateObject

The GroupByClauseStateObject

addHavingClause back to summary

addHavingClause	back to summary
public HavingClauseStateObject addHavingClause() Adds the `HAVING` clause. The clause is not added if it's already present. Returns:HavingClauseStateObject The `GroupByClauseStateObject`

public HavingClauseStateObject addHavingClause()

Adds the HAVING clause. The clause is not added if it's already present.

Returns:HavingClauseStateObject: The GroupByClauseStateObject

addHavingClause back to summary

addHavingClause	back to summary
public HavingClauseStateObject addHavingClause(String jpqlFragment) Adds the `HAVING` clause and parses the given JPQL fragment. The clause is not added if it's already present. Parameters jpqlFragment:String The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with `HAVING` Returns:HavingClauseStateObject The `HavingClauseStateObject`

public HavingClauseStateObject addHavingClause(String jpqlFragment)

Adds the HAVING clause and parses the given JPQL fragment. The clause is not added if it's already present.

Parameters

jpqlFragment:String: The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with HAVING

Returns:HavingClauseStateObject

The HavingClauseStateObject

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 new range variable declaration

public IdentificationVariableDeclarationStateObject addRangeDeclaration()

Adds a new range variable declaration to the FROM clause.

Returns:IdentificationVariableDeclarationStateObject: The StateObject representing the new range variable declaration

addRangeDeclaration back to summary

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 given `IEntity` Returns:IdentificationVariableDeclarationStateObject The `StateObject` representing the new range variable declaration

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 given IEntity

Returns:IdentificationVariableDeclarationStateObject

The StateObject representing the new range variable declaration

addRangeDeclaration back to summary

addRangeDeclaration	back to summary
public IdentificationVariableDeclarationStateObject addRangeDeclaration(String entityName, String identificationVariable) Adds to this select statement a new range variable declaration. Parameters entityName:String The name of the entity identificationVariable:String The unique identifier identifying the entity Returns:IdentificationVariableDeclarationStateObject The `StateObject` representing the range variable declaration

public IdentificationVariableDeclarationStateObject addRangeDeclaration(String entityName, String identificationVariable)

Adds to this select statement a new range variable declaration.

Parameters

entityName:String: The name of the entity
identificationVariable:String: The unique identifier identifying the entity

Returns:IdentificationVariableDeclarationStateObject

The StateObject representing the range variable declaration

addWhereClause back to summary

addWhereClause	back to summary
public WhereClauseStateObject addWhereClause() Adds the `WHERE` clause. The clause is not added if it's already present. Returns:WhereClauseStateObject The `GroupByClauseStateObject`

public WhereClauseStateObject addWhereClause()

Adds the WHERE clause. The clause is not added if it's already present.

Returns:WhereClauseStateObject: The GroupByClauseStateObject

addWhereClause back to summary

addWhereClause	back to summary
public WhereClauseStateObject addWhereClause(String jpqlFragment) Adds the `WHERE` clause and parses the given JPQL fragment. The clause is not added if it's already present. Parameters jpqlFragment:String The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with `WHERE` Returns:WhereClauseStateObject The `WhereClauseStateObject`

public WhereClauseStateObject addWhereClause(String jpqlFragment)

Adds the WHERE clause and parses the given JPQL fragment. The clause is not added if it's already present.

Parameters

jpqlFragment:String: The fragment of the JPQL to parse that represents the conditional expression, the fragment cannot start with WHERE

Returns:WhereClauseStateObject

The WhereClauseStateObject

buildFromClause back to summary

buildFromClause	back to summary
protected abstract AbstractFromClauseStateObject buildFromClause() Creates the state object representing the `FROM` clause. Returns:AbstractFromClauseStateObject A concrete instance of `AbstractFromClauseStateObject`

protected abstract AbstractFromClauseStateObject buildFromClause()

Creates the state object representing the FROM clause.

Returns:AbstractFromClauseStateObject: A concrete instance of AbstractFromClauseStateObject

buildSelectClause back to summary

buildSelectClause	back to summary
protected abstract AbstractSelectClauseStateObject buildSelectClause() Creates the state object representing the `SELECT` clause. Returns:AbstractSelectClauseStateObject A concrete instance of `AbstractSelectClauseStateObject`

protected abstract AbstractSelectClauseStateObject buildSelectClause()

Creates the state object representing the SELECT clause.

Returns:AbstractSelectClauseStateObject: A concrete instance of AbstractSelectClauseStateObject

declarations back to summary

declarations	back to summary
public ListIterable<? extends VariableDeclarationStateObject> declarations() Returns the list of `VariableDeclarationStateObject` defining the variable declarations, which are mapping an entity to a variable or a collection-valued member to a variable. Example: `Employee e` `IN (e.employees) AS emps` Returns:ListIterable<? extends VariableDeclarationStateObject> The list of `VariableDeclarationStateObject`

public ListIterable<? extends VariableDeclarationStateObject> declarations()

Returns the list of VariableDeclarationStateObject defining the variable declarations, which are mapping an entity to a variable or a collection-valued member to a variable.

Example:

Employee e
IN (e.employees) AS emps

Returns:ListIterable<? extends VariableDeclarationStateObject>: The list of VariableDeclarationStateObject

findIdentificationVariable back to summary

findIdentificationVariable	back to summary
public IdentificationVariableStateObject findIdentificationVariable(String identificationVariable) 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 identificationVariable: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 identificationVariable)

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

identificationVariable: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 AbstractSelectStatement 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:AbstractSelectStatement 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 AbstractSelectStatement 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:AbstractSelectStatement

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

getFromClause back to summary

getFromClause	back to summary
public AbstractFromClauseStateObject getFromClause() Returns the state object representing the `FROM` clause. Returns:AbstractFromClauseStateObject The state object representing the `FROM` clause, which is never `null`

public AbstractFromClauseStateObject getFromClause()

Returns the state object representing the FROM clause.

Returns:AbstractFromClauseStateObject: The state object representing the FROM clause, which is never null

getGroupByClause back to summary

getGroupByClause	back to summary
public GroupByClauseStateObject getGroupByClause() Returns the state object representing the `GROUP BY` clause. Returns:GroupByClauseStateObject Either the actual state object representing the `GROUP BY` clause or `null` if it's not present

public GroupByClauseStateObject getGroupByClause()

Returns the state object representing the GROUP BY clause.

Returns:GroupByClauseStateObject: Either the actual state object representing the GROUP BY clause or null if it's not present

getHavingClause back to summary

getHavingClause	back to summary
public HavingClauseStateObject getHavingClause() Returns the state object representing the `HAVING` clause. Returns:HavingClauseStateObject Either the actual state object representing the `HAVING` clause or `null` if it's not present

public HavingClauseStateObject getHavingClause()

Returns the state object representing the HAVING clause.

Returns:HavingClauseStateObject: Either the actual state object representing the HAVING clause or null if it's not present

getSelectClause back to summary

getSelectClause	back to summary
public AbstractSelectClauseStateObject getSelectClause() Returns the state object representing the `SELECT` clause. Returns:AbstractSelectClauseStateObject Either the actual state object representing the `SELECT` clause, which is never `null`

public AbstractSelectClauseStateObject getSelectClause()

Returns the state object representing the SELECT clause.

Returns:AbstractSelectClauseStateObject: Either the actual state object representing the SELECT clause, which is never null

getWhereClause back to summary

getWhereClause	back to summary
public WhereClauseStateObject getWhereClause() Returns the state object representing the `WHERE` clause. Returns:WhereClauseStateObject Either the actual state object representing the `WHERE` clause or the `null` state object since `null` is never returned

public WhereClauseStateObject getWhereClause()

Returns the state object representing the WHERE clause.

Returns:WhereClauseStateObject: Either the actual state object representing the WHERE clause or the null state object since null is never returned

hasGroupByClause back to summary

hasGroupByClause	back to summary
public boolean hasGroupByClause() Returns the state object representing the `GROUP BY` clause. Returns:boolean Either the actual state object representing the `GROUP BY` clause or `null` if it's not present

public boolean hasGroupByClause()

Returns the state object representing the GROUP BY clause.

Returns:boolean: Either the actual state object representing the GROUP BY clause or null if it's not present

hasHavingClause back to summary

hasHavingClause	back to summary
public boolean hasHavingClause() Returns the state object representing the `HAVING` clause. Returns:boolean Either the actual state object representing the `HAVING` clause or `null` if it's not present

public boolean hasHavingClause()

Returns the state object representing the HAVING clause.

Returns:boolean: Either the actual state object representing the HAVING clause or null if it's not present

hasWhereClause back to summary

hasWhereClause	back to summary
public boolean hasWhereClause() Returns the state object representing the `WHERE` clause. Returns:boolean Either the actual state object representing the `WHERE` clause or `null` if it's not present

public boolean hasWhereClause()

Returns the state object representing the WHERE clause.

Returns:boolean: Either the actual state object representing the WHERE clause or null if it's not present

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

initialize	back to summary
protected void initialize() Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize. Initializes this state object. Annotations @Override

initialize

back to summary

protected void initialize()

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

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

Initializes this state object.

Annotations

@Override

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

parseSelect	back to summary
public void parseSelect(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

parseSelect

back to summary

public void parseSelect(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

removeGroupByClause	back to summary
public void removeGroupByClause() Removes the `GROUP BY` clause.

removeHavingClause	back to summary
public void removeHavingClause() Removes the `HAVING` clause.

removeWhereClause	back to summary
public void removeWhereClause() Removes the `WHERE` clause.

setGroupByClause	back to summary
private void setGroupByClause(GroupByClauseStateObject groupByClause)

setHavingClause	back to summary
private void setHavingClause(HavingClauseStateObject havingClause)

setWhereClause	back to summary
private void setWhereClause(WhereClauseStateObject whereClause)

toggleGroupByClause	back to summary
public void toggleGroupByClause() Either adds or removes the state object representing the `GROUP BY` clause.

toggleHavingClause	back to summary
public void toggleHavingClause() Either adds or removes the state object representing the `HAVING` clause.

toggleWhereClause	back to summary
public void toggleWhereClause() Either adds or removes the state object representing the `WHERE` clause.

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

public abstract Class AbstractSelectStatementStateObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail