Class NullComparisonExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.NullComparisonExpressionStateObject
-
- All Implemented Interfaces:
StateObject
public class NullComparisonExpressionStateObject extends AbstractStateObject
A null comparison tests whether or not the single-valued path expression or input parameter is aNULLvalue.BNF:null_comparison_expression ::= {single_valued_path_expression | input_parameter} IS [NOT] NULL- Version:
- 2.4
- See Also:
NullComparisonExpression- 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.static java.lang.StringSTATE_OBJECT_PROPERTYNotifies the state object property has changed.
-
Constructor Summary
Constructors Constructor Description NullComparisonExpressionStateObject(StateObject parent)Creates a newNullComparisonExpressionStateObject.NullComparisonExpressionStateObject(StateObject parent, boolean not, java.lang.String path)Creates a newNullComparisonExpressionStateObject.NullComparisonExpressionStateObject(StateObject parent, boolean not, StateObject stateObject)Creates a newNullComparisonExpressionStateObject.NullComparisonExpressionStateObject(StateObject parent, java.lang.String path)Creates a newNullComparisonExpressionStateObject.NullComparisonExpressionStateObject(StateObject parent, StateObject stateObject)Creates a newNullComparisonExpressionStateObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StateObjectVisitor visitor)Visits thisStateObjectby the givenvisitor.protected voidaddChildren(java.util.List<StateObject> children)Adds the children of thisStateObjectto the given list.NullComparisonExpressionStateObjectaddNot()Makes sure theNOTidentifier is specified.NullComparisonExpressiongetExpression()Returns the actual parsed object if thisStateObjectrepresentation of the JPQL query was created by parsing an existing JPQL query.StateObjectgetStateObject()Returns theStateObjectrepresenting the collection-valued path expression.booleanhasNot()Determines whether theNOTidentifier is used or not.booleanhasStateObject()Determines whether there is aStateObjectrepresenting the collection-valued path expression.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(NullComparisonExpression 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 givenStateObjectas the collection-valued path expression.voidtoggleNot()Changes the visibility state of theNOTidentifier.protected voidtoTextInternal(java.lang.Appendable writer)Prints out a string representation of thisStateObject, 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.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
-
STATE_OBJECT_PROPERTY
public static final java.lang.String STATE_OBJECT_PROPERTY
Notifies the state object property has changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NullComparisonExpressionStateObject
public NullComparisonExpressionStateObject(StateObject parent)
Creates a newNullComparisonExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benull- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
NullComparisonExpressionStateObject
public NullComparisonExpressionStateObject(StateObject parent, boolean not, StateObject stateObject)
Creates a newNullComparisonExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullnot- Determines whether theNOTidentifier is part of the expression or notstateObject- TheStateObjectrepresenting the collection-valued path expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
NullComparisonExpressionStateObject
public NullComparisonExpressionStateObject(StateObject parent, boolean not, java.lang.String path)
Creates a newNullComparisonExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullnot- Determines whether theNOTidentifier is part of the expression or notpath- Either the singled-valued path expression or the input parameter- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
NullComparisonExpressionStateObject
public NullComparisonExpressionStateObject(StateObject parent, StateObject stateObject)
Creates a newNullComparisonExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullstateObject- TheStateObjectrepresenting the collection-valued path expression- Throws:
java.lang.NullPointerException- The given parent cannot benull
-
NullComparisonExpressionStateObject
public NullComparisonExpressionStateObject(StateObject parent, java.lang.String path)
Creates a newNullComparisonExpressionStateObject.- Parameters:
parent- The parent of this state object, which cannot benullpath- Either the singled-valued path expression or the input parameter- 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
-
addChildren
protected void addChildren(java.util.List<StateObject> children)
Adds the children of thisStateObjectto the given list.- Overrides:
addChildrenin classAbstractStateObject- Parameters:
children- The list used to store the children
-
addNot
public NullComparisonExpressionStateObject addNot()
Makes sure theNOTidentifier is specified.- Returns:
- This object
-
getExpression
public NullComparisonExpression 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 classAbstractStateObject- 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)
-
getStateObject
public StateObject getStateObject()
Returns theStateObjectrepresenting the collection-valued path expression.- Returns:
- The
StateObjectrepresenting the collection-valued path expression
-
hasNot
public boolean hasNot()
Determines whether theNOTidentifier is used or not.- Returns:
trueif theNOTidentifier is part of the expression;falseotherwise
-
hasStateObject
public boolean hasStateObject()
Determines whether there is aStateObjectrepresenting the collection-valued path expression.- Returns:
trueif theStateObjectis notnull;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 classAbstractStateObject- 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(NullComparisonExpression 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 the null expression
-
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 givenStateObjectas the collection-valued path expression.- Parameters:
stateObject- TheStateObjectthat represents the collection-valued path expression
-
toggleNot
public void toggleNot()
Changes the visibility state of theNOTidentifier.
-
toTextInternal
protected void toTextInternal(java.lang.Appendable writer) throws java.io.IOExceptionPrints out a string representation of thisStateObject, which should not be used to define atruestring representation of a JPQL query but should be used for debugging purposes.- Specified by:
toTextInternalin classAbstractStateObject- Parameters:
writer- The writer used to print out the string representation- Throws:
java.io.IOException- This should never happens, it is only required becauseAppendableis used instead of any concrete class
-
-