Module org.eclipse.persistence.jpa.jpql

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

Class WhereClauseStateObject

java.lang.Object

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

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

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

All Implemented Interfaces:

StateObject

public class WhereClauseStateObject
extends AbstractConditionalClauseStateObject

The WHERE clause of a query consists of a conditional expression used to select objects or values that satisfy the expression. The WHERE clause restricts the result of a select statement or the scope of an update or delete operation.

BNF: where_clause ::= WHERE conditional_expression

Since:

2.4

Version:

2.4

See Also:

• WhereClause

Field Summary

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

CONDITIONAL_STATE_OBJECT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WhereClauseStateObject(AbstractModifyStatementStateObject parent)	Creates a new WhereClauseStateObject.
WhereClauseStateObject(AbstractSelectStatementStateObject parent)	Creates a new WhereClauseStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
WhereClause	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
String	getIdentifier()	Returns the JPQL identifier of this clause.
void	setExpression(WhereClause 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.

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

addChildren, andParse, getBuilder, getConditional, hasConditional, isEquivalent, orParse, parse, setConditional, shouldEncapsulateORExpression, toTextInternal

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, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, initialize, 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

Constructor Details

WhereClauseStateObject

public WhereClauseStateObject(AbstractModifyStatementStateObject parent)

Creates a new WhereClauseStateObject.

Parameters:

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

Throws:

NullPointerException - The given parent cannot be null

WhereClauseStateObject

public WhereClauseStateObject(AbstractSelectStatementStateObject parent)

Creates a new WhereClauseStateObject.

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

getExpression

public WhereClause 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 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)

getIdentifier

public String getIdentifier()

Description copied from class: AbstractConditionalClauseStateObject

Returns the JPQL identifier of this clause.

Specified by:

getIdentifier in class AbstractConditionalClauseStateObject

Returns:

The JPQL identifier of this conditional clause

setExpression

public void setExpression(WhereClause 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 Where clause