Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.tools.model.query

Class SelectStatementStateObject

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectStatementStateObject

org.eclipse.persistence.jpa.jpql.tools.model.query.SelectStatementStateObject

All Implemented Interfaces:

StateObject

public class SelectStatementStateObject
extends AbstractSelectStatementStateObject

This state object represents a select statement, which has at least a SELECT clause and a FROM clause. The other clauses are optional.

BNF: select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]

Since:

2.4

Version:

2.4

See Also:

• FromClauseStateObject
• GroupByClauseStateObject
• HavingClauseStateObject
• OrderByClauseStateObject
• SelectClauseStateObject
• WhereClauseStateObject
• SelectStatement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_BY_CLAUSE_PROPERTY	Notify the state object representing the ORDER BY clause has changed.

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectStatementStateObject

GROUP_BY_CLAUSE_PROPERTY, HAVING_CLAUSE_PROPERTY, WHERE_CLAUSE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
SelectStatementStateObject(JPQLQueryStateObject parent)	Creates a new SelectStatementStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
protected void	addChildren(List<StateObject> children)	Adds the children of this StateObject to the given list.
OrderByClauseStateObject	addOrderByClause()	Adds the ORDER BY clause.
OrderByClauseStateObject	addOrderByClause(String jpqlFragment)	Adds the ORDER BY clause and parses the given JPQL fragment, which should represent one or many ordering items.
StateObject	addSelectItem(String path)	Adds the given path as a select item, which can either be an identification variable or a state-field path expression.
ResultVariableStateObject	addSelectItem(String jpqlFragment, String resultVariable)	Adds the given expression as a select item.
void	addSelectItem(StateObject stateObject)	Adds the given StateObject as a select item.
ResultVariableStateObject	addSelectItem(StateObject stateObject, String resultVariable)	Adds the given StateObject as a select item.
ResultVariableStateObject	addSelectItemAs(String jpqlFragment, String resultVariable)	Adds the given expression as a select item.
ResultVariableStateObject	addSelectItemAs(StateObject stateObject, String resultVariable)	Adds the given StateObject as a select item.
protected AbstractFromClauseStateObject	buildFromClause()	Creates the state object representing the FROM clause.
protected AbstractSelectClauseStateObject	buildSelectClause()	Creates the state object representing the SELECT clause.
SelectStatement	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
FromClauseStateObject	getFromClause()	Returns the state object representing the FROM clause.
OrderByClauseStateObject	getOrderByClause()	Returns the state object representing the ORDER BY clause.
JPQLQueryStateObject	getParent()	Returns the parent of this StateObject.
ISelectExpressionStateObjectBuilder	getSelectBuilder()	Creates and returns a new ISelectExpressionStateObjectBuilder that can be used to programmatically create a single select expression and once the expression is complete, ISelectExpressionStateObjectBuilder.commit() will push the StateObject representation of that expression as this clause's select expression.
SelectClauseStateObject	getSelectClause()	Returns the state object representing the SELECT clause.
boolean	hasOrderByClause()	Returns the state object representing the ORDER BY clause.
boolean	isEquivalent(StateObject stateObject)	Determines whether the given StateObject is equivalent to this one, i.e.
void	removeOrderByClause()	Removes the ORDER BY clause.
void	setExpression(SelectStatement expression)	Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.
void	toggleOrderByClause()	Either adds or removes the ORDER BY clause.
protected void	toTextInternal(Appendable writer)	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.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectStatementStateObject

addCollectionDeclaration, addCollectionDeclaration, addGroupByClause, addGroupByClause, addHavingClause, addHavingClause, addRangeDeclaration, addRangeDeclaration, addRangeDeclaration, addWhereClause, addWhereClause, declarations, findIdentificationVariable, getDeclaration, getGroupByClause, getHavingClause, getWhereClause, hasGroupByClause, hasHavingClause, hasWhereClause, identificationVariables, initialize, parseSelect, removeGroupByClause, removeHavingClause, removeWhereClause, toggleGroupByClause, toggleHavingClause, toggleWhereClause

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, firePropertyChanged, getChangeSupport, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ORDER_BY_CLAUSE_PROPERTY

public static final String ORDER_BY_CLAUSE_PROPERTY

Notify the state object representing the ORDER BY clause has changed.

See Also:

• Constant Field Values

Constructor Details

SelectStatementStateObject

public SelectStatementStateObject(JPQLQueryStateObject parent)

Creates a new SelectStatementStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

NullPointerException - The given parent cannot be null

Method Details

accept

public void accept(StateObjectVisitor visitor)

Description copied from interface: StateObject

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

addChildren

protected void addChildren(List<StateObject> children)

Description copied from class: AbstractStateObject

Adds the children of this StateObject to the given list.

Overrides:

addChildren in class AbstractSelectStatementStateObject

Parameters:

children - The list used to store the children

addOrderByClause

public OrderByClauseStateObject addOrderByClause()

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

Returns:

The state object representing the ORDER BY clause

addOrderByClause

public OrderByClauseStateObject addOrderByClause(String jpqlFragment)

Adds the ORDER BY clause and parses the given JPQL fragment, which should represent one or many ordering items. The clause is not added if it's already present.

Parameters:

jpqlFragment - The fragment of the JPQL to parse that represents the ordering items, the fragment cannot start with ORDER BY

Returns:

The OrderByClauseStateObject

addSelectItem

public void addSelectItem(StateObject stateObject)

Adds the given StateObject as a select item.

Parameters:

stateObject - The StateObject representing a select expression

addSelectItem

public ResultVariableStateObject addSelectItem(StateObject stateObject,
 String resultVariable)

Adds the given StateObject as a select item.

Parameters:

stateObject - The StateObject representing the select expression

resultVariable - The result variable identifying the select expression

Returns:

The newly created ResultVariableStateObject

addSelectItem

public StateObject addSelectItem(String path)

Adds the given path as a select item, which can either be an identification variable or a state-field path expression.

Parameters:

path - The select expression to parse as a select item

Returns:

The StateObject encapsulating the given path

addSelectItem

public ResultVariableStateObject addSelectItem(String jpqlFragment,
 String resultVariable)

Adds the given expression as a select item.

Parameters:

jpqlFragment - The select expression to parse as a select item

resultVariable - The result variable identifying the select expression

Returns:

The newly created ResultVariableStateObject

addSelectItemAs

public ResultVariableStateObject addSelectItemAs(StateObject stateObject,
 String resultVariable)

Adds the given StateObject as a select item.

Parameters:

stateObject - The StateObject representing the select expression

resultVariable - The result variable identifying the select expression

Returns:

The newly created ResultVariableStateObject

addSelectItemAs

public ResultVariableStateObject addSelectItemAs(String jpqlFragment,
 String resultVariable)

Adds the given expression as a select item.

Parameters:

jpqlFragment - The portion of a JPQL query that represents a select expression

resultVariable - The result variable identifying the select expression

Returns:

The newly created ResultVariableStateObject

buildFromClause

protected AbstractFromClauseStateObject buildFromClause()

Description copied from class: AbstractSelectStatementStateObject

Creates the state object representing the FROM clause.

Specified by:

buildFromClause in class AbstractSelectStatementStateObject

Returns:

A concrete instance of AbstractFromClauseStateObject

buildSelectClause

protected AbstractSelectClauseStateObject buildSelectClause()

Description copied from class: AbstractSelectStatementStateObject

Creates the state object representing the SELECT clause.

Specified by:

buildSelectClause in class AbstractSelectStatementStateObject

Returns:

A concrete instance of AbstractSelectClauseStateObject

getExpression

public SelectStatement getExpression()

Description copied from interface: StateObject

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 AbstractSelectStatementStateObject

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)

getFromClause

public FromClauseStateObject getFromClause()

Description copied from class: AbstractSelectStatementStateObject

Returns the state object representing the FROM clause.

Overrides:

getFromClause in class AbstractSelectStatementStateObject

Returns:

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

getOrderByClause

public OrderByClauseStateObject getOrderByClause()

Returns the state object representing the ORDER BY clause.

Returns:

Either the actual state object representing the ORDER BY clause or null if it's not present

getParent

public JPQLQueryStateObject getParent()

Description copied from interface: StateObject

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

getSelectBuilder

public ISelectExpressionStateObjectBuilder getSelectBuilder()

Creates and returns a new ISelectExpressionStateObjectBuilder that can be used to programmatically create a single select expression and once the expression is complete, ISelectExpressionStateObjectBuilder.commit() will push the StateObject representation of that expression as this clause's select expression.

Returns:

A new builder that can be used to quickly create a select expression

getSelectClause

public SelectClauseStateObject getSelectClause()

Description copied from class: AbstractSelectStatementStateObject

Returns the state object representing the SELECT clause.

Overrides:

getSelectClause in class AbstractSelectStatementStateObject

Returns:

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

hasOrderByClause

public boolean hasOrderByClause()

Returns the state object representing the ORDER BY clause.

Returns:

true if the ORDER BY clause is present; false otherwise

isEquivalent

public boolean isEquivalent(StateObject stateObject)

Description copied from interface: 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 AbstractSelectStatementStateObject

Parameters:

stateObject - The StateObject to compare its content to this one

Returns:

true if both object are equivalent; false otherwise

removeOrderByClause

public void removeOrderByClause()

Removes the ORDER BY clause.

setExpression

public void setExpression(SelectStatement expression)

Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.

Parameters:

expression - The parsed object representing a SELECT statement

toggleOrderByClause

public void toggleOrderByClause()

Either adds or removes the ORDER BY clause.

toTextInternal

protected void toTextInternal(Appendable writer)
                       throws IOException

Description copied from class: AbstractStateObject

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.

Overrides:

toTextInternal in class AbstractSelectStatementStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

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