Class ExistsExpressionStateObject
java.lang.Object
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
org.eclipse.persistence.jpa.jpql.tools.model.query.ExistsExpressionStateObject
- All Implemented Interfaces:
StateObject
An
EXISTS
expression is a predicate that is true
only if the
result of the subquery consists of one or more values and that is false
otherwise.
BNF: exists_expression ::= [NOT] EXISTS(subquery)
- Since:
- 2.4
- Version:
- 2.4
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Notifies the visibility of theNOT
identifier has changed.Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
STATE_OBJECT_PROPERTY
-
Constructor Summary
ConstructorDescriptionCreates a newExistsExpressionStateObject
.ExistsExpressionStateObject
(StateObject parent, boolean not, String jpqlFragment) Creates a newExistsExpressionStateObject
.ExistsExpressionStateObject
(StateObject parent, boolean not, StateObject stateObject) Creates a newExistsExpressionStateObject
.ExistsExpressionStateObject
(StateObject parent, String jpqlFragment) Creates a newExistsExpressionStateObject
.ExistsExpressionStateObject
(StateObject parent, StateObject stateObject) Creates a newExistsExpressionStateObject
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(StateObjectVisitor visitor) Visits thisStateObject
by the givenvisitor
.addNot()
Makes sure theNOT
identifier is specified.Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject
.protected String
Returns the unique identifier of theJPQLQueryBNF
that will determine how to parse the encapsulated expression.boolean
hasNot()
Determines whether theNOT
identifier is used or not.boolean
isEquivalent
(StateObject stateObject) Determines whether the givenStateObject
is equivalent to this one, i.e.void
Makes sure theNOT
identifier is not specified.void
setExpression
(ExistsExpression expression) Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.void
setNot
(boolean not) Sets whether theNOT
identifier should be part of the expression or not.void
setStateObject
(StateObject stateObject) Sets the givenStateObject
to represent the new encapsulated expression.void
Changes the visibility state of theNOT
identifier.protected void
Prints out a string representation of this encapsulated information, which should not be used to define atrue
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.AbstractSingleEncapsulatedExpressionStateObject
addChildren, getStateObject, hasStateObject, parse
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject
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
-
Field Details
-
NOT_PROPERTY
Notifies the visibility of theNOT
identifier has changed.- See Also:
-
-
Constructor Details
-
ExistsExpressionStateObject
Creates a newExistsExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
NullPointerException
- The given parent cannot benull
-
ExistsExpressionStateObject
Creates a newExistsExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
not
- Determines whether theNOT
identifier is part of the expression or notstateObject
- TheStateObject
representing the subquery- Throws:
NullPointerException
- The given parent cannot benull
-
ExistsExpressionStateObject
Creates a newExistsExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
not
- Determines whether theNOT
identifier is part of the expression or notjpqlFragment
- The portion of the query representing the encapsulated expression- Throws:
NullPointerException
- The given parent cannot benull
-
ExistsExpressionStateObject
Creates a newExistsExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
stateObject
- TheStateObject
representing the subquery- Throws:
NullPointerException
- The given parent cannot benull
-
ExistsExpressionStateObject
Creates a newExistsExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
jpqlFragment
- The portion of the query representing the encapsulated expression- Throws:
NullPointerException
- The given parent cannot benull
-
-
Method Details
-
accept
Description copied from interface:StateObject
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
addNot
Makes sure theNOT
identifier is specified.- Returns:
- This object
-
getExpression
Description copied from interface:StateObject
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractSingleEncapsulatedExpressionStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getIdentifier
Description copied from class:AbstractEncapsulatedExpressionStateObject
Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject
.- Specified by:
getIdentifier
in classAbstractEncapsulatedExpressionStateObject
- Returns:
- The JPQL identifier that is shown before the left parenthesis
-
getQueryBNFId
Description copied from class:AbstractSingleEncapsulatedExpressionStateObject
Returns the unique identifier of theJPQLQueryBNF
that will determine how to parse the encapsulated expression.- Specified by:
getQueryBNFId
in classAbstractSingleEncapsulatedExpressionStateObject
- Returns:
- The non-
null
ID of the BNF
-
hasNot
public boolean hasNot()Determines whether theNOT
identifier is used or not.- Returns:
true
if theNOT
identifier is part of the expression;false
otherwise
-
isEquivalent
Description copied from interface:StateObject
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractSingleEncapsulatedExpressionStateObject
- Parameters:
stateObject
- TheStateObject
to compare its content to this one- Returns:
true
if both object are equivalent;false
otherwise
-
removeNot
public void removeNot()Makes sure theNOT
identifier is not specified. -
setExpression
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing anEXISTS
expression
-
setNot
public void setNot(boolean not) Sets whether theNOT
identifier should be part of the expression or not.- Parameters:
not
-true
if theNOT
identifier should be part of the expression;false
otherwise
-
setStateObject
Description copied from class:AbstractSingleEncapsulatedExpressionStateObject
Sets the givenStateObject
to represent the new encapsulated expression.- Overrides:
setStateObject
in classAbstractSingleEncapsulatedExpressionStateObject
- Parameters:
stateObject
- The new encapsulatedStateObject
-
toggleNot
public void toggleNot()Changes the visibility state of theNOT
identifier. -
toTextEncapsulatedExpression
Description copied from class:AbstractEncapsulatedExpressionStateObject
Prints out a string representation of this encapsulated information, which should not be used to define atrue
string representation of a JPQL query but should be used for debugging purposes.- Overrides:
toTextEncapsulatedExpression
in classAbstractSingleEncapsulatedExpressionStateObject
- Parameters:
writer
- The writer used to print out the string representation of the encapsulated information- Throws:
IOException
- This should never happens, only required becauseAppendable
is used instead ofStringBuilder
for instance
-