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
public class ExistsExpressionStateObject extends AbstractSingleEncapsulatedExpressionStateObject
AnEXISTSexpression is a predicate that istrueonly if the result of the subquery consists of one or more values and that isfalseotherwise.BNF:exists_expression ::= [NOT] EXISTS(subquery)- Version:
- 2.4
- See Also:
ExistsExpression- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNOT_PROPERTYNotifies the visibility of theNOTidentifier has changed.-
Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject
STATE_OBJECT_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description ExistsExpressionStateObject(StateObject parent)Creates a newExistsExpressionStateObject.ExistsExpressionStateObject(StateObject parent, boolean not, java.lang.String jpqlFragment)Creates a newExistsExpressionStateObject.ExistsExpressionStateObject(StateObject parent, boolean not, StateObject stateObject)Creates a newExistsExpressionStateObject.ExistsExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)Creates a newExistsExpressionStateObject.ExistsExpressionStateObject(StateObject parent, StateObject stateObject)Creates a newExistsExpressionStateObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StateObjectVisitor visitor)Visits thisStateObjectby the givenvisitor.ExistsExpressionStateObjectaddNot()Makes sure theNOTidentifier is specified.ExistsExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.java.lang.StringgetIdentifier()Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject.protected java.lang.StringgetQueryBNFId()Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.booleanhasNot()Determines whether theNOTidentifier is used or not.booleanisEquivalent(StateObject stateObject)Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.voidremoveNot()Makes sure theNOTidentifier is not specified.voidsetExpression(ExistsExpression expression)Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.voidsetNot(boolean not)Sets whether theNOTidentifier should be part of the expression or not.voidsetStateObject(StateObject stateObject)Sets the givenStateObjectto represent the new encapsulated expression.voidtoggleNot()Changes the visibility state of theNOTidentifier.protected voidtoTextEncapsulatedExpression(java.lang.Appendable writer)Prints out a string representation of this encapsulated information, which should not be used to define atruestring 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 Detail
-
NOT_PROPERTY
public static final java.lang.String NOT_PROPERTY
Notifies the visibility of theNOTidentifier has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ExistsExpressionStateObject
public ExistsExpressionStateObject(StateObject parent)
Creates a newExistsExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
ExistsExpressionStateObject
public ExistsExpressionStateObject(StateObject parent, boolean not, StateObject stateObject)
Creates a newExistsExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullnot- Determines whether theNOTidentifier is part of the expression or notstateObject- TheStateObjectrepresenting the subquery- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
ExistsExpressionStateObject
public ExistsExpressionStateObject(StateObject parent, boolean not, java.lang.String jpqlFragment)
Creates a newExistsExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullnot- Determines whether theNOTidentifier is part of the expression or notjpqlFragment- The portion of the query representing the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
ExistsExpressionStateObject
public ExistsExpressionStateObject(StateObject parent, StateObject stateObject)
Creates a newExistsExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullstateObject- TheStateObjectrepresenting the subquery- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
ExistsExpressionStateObject
public ExistsExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)
Creates a newExistsExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benulljpqlFragment- The portion of the query representing the encapsulated expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObjectby the givenvisitor.- Parameters:
visitor- Thevisitorto visit this object
-
addNot
public ExistsExpressionStateObject addNot()
Makes sure theNOTidentifier is specified.- Returns:
- This object
-
getExpression
public ExistsExpression getExpression()
Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpressionin interfaceStateObject- Overrides:
getExpressionin classAbstractSingleEncapsulatedExpressionStateObject- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObjectornullwhen the JPQL query is manually created (i.e. not from a string)
-
getIdentifier
public java.lang.String getIdentifier()
Returns the JPQL identifier of the expression represented by thisAbstractSingleEncapsulatedExpressionStateObject.- Specified by:
getIdentifierin classAbstractEncapsulatedExpressionStateObject- Returns:
- The JPQL identifier that is shown before the left parenthesis
-
getQueryBNFId
protected java.lang.String getQueryBNFId()
Returns the unique identifier of theJPQLQueryBNFthat will determine how to parse the encapsulated expression.- Specified by:
getQueryBNFIdin classAbstractSingleEncapsulatedExpressionStateObject- Returns:
- The non-
nullID of the BNF
-
hasNot
public boolean hasNot()
Determines whether theNOTidentifier is used or not.- Returns:
trueif theNOTidentifier is part of the expression;falseotherwise
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObjectis equivalent to this one, i.e. the information of bothStateObjectis the same.- Specified by:
isEquivalentin interfaceStateObject- Overrides:
isEquivalentin classAbstractSingleEncapsulatedExpressionStateObject- Parameters:
stateObject- TheStateObjectto compare its content to this one- Returns:
trueif both object are equivalent;falseotherwise
-
removeNot
public void removeNot()
Makes sure theNOTidentifier is not specified.
-
setExpression
public void setExpression(ExistsExpression expression)
Keeps a reference of theparsed objectobject, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects.- Parameters:
expression- Theparsed objectrepresenting anEXISTSexpression
-
setNot
public void setNot(boolean not)
Sets whether theNOTidentifier should be part of the expression or not.- Parameters:
not-trueif theNOTidentifier should be part of the expression;falseotherwise
-
setStateObject
public void setStateObject(StateObject stateObject)
Sets the givenStateObjectto represent the new encapsulated expression.- Overrides:
setStateObjectin classAbstractSingleEncapsulatedExpressionStateObject- Parameters:
stateObject- The new encapsulatedStateObject
-
toggleNot
public void toggleNot()
Changes the visibility state of theNOTidentifier.
-
toTextEncapsulatedExpression
protected void toTextEncapsulatedExpression(java.lang.Appendable writer) throws java.io.IOExceptionPrints out a string representation of this encapsulated information, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.- Overrides:
toTextEncapsulatedExpressionin classAbstractSingleEncapsulatedExpressionStateObject- Parameters:
writer- The writer used to print out the string representation of the encapsulated information- Throws:
java.io.IOException- This should never happens, only required becauseAppendableis used instead ofStringBuilderfor instance
-
-