Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model.query

public Class NullComparisonExpressionStateObject

extends AbstractStateObject
Class Inheritance
Annotations
@SuppressWarnings:nls, unused
Imports
java.io.IOException, java.util.List, org.eclipse.persistence.jpa.jpql.parser.LiteralBNF, .NullComparisonExpression
A null comparison tests whether or not the single-valued path expression or input parameter is a NULL value.

BNF: null_comparison_expression ::= {single_valued_path_expression | input_parameter} IS [NOT] NULL

Author
Pascal Filion
Since
2.4
Version
2.4
See Also
NullComparisonExpression

Field Summary

Modifier and TypeField and Description
private boolean
not

Determines whether the NOT identifier is part of the expression or not.

public static final String
NOT_PROPERTY

Notifies the visibility of the NOT identifier has changed.

public static final String
STATE_OBJECT_PROPERTY

Notifies the state object property has changed.

private StateObject
stateObject

The StateObject representing the collection-valued path expression.

Constructor Summary

AccessConstructor and Description
public
NullComparisonExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent)

Creates a new NullComparisonExpressionStateObject.

public
NullComparisonExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, boolean
Determines whether the NOT identifier is part of the expression or not
not, StateObject
The StateObject representing the collection-valued path expression
stateObject)

Creates a new NullComparisonExpressionStateObject.

public
NullComparisonExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, boolean
Determines whether the NOT identifier is part of the expression or not
not, String
Either the singled-valued path expression or the input parameter
path)

Creates a new NullComparisonExpressionStateObject.

public
NullComparisonExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, StateObject
The StateObject representing the collection-valued path expression
stateObject)

Creates a new NullComparisonExpressionStateObject.

public
NullComparisonExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, String
Either the singled-valued path expression or the input parameter
path)

Creates a new NullComparisonExpressionStateObject.

Method Summary

Modifier and TypeMethod and Description
public void
accept(StateObjectVisitor
The visitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.
protected void
addChildren(List<StateObject>
The list used to store the children
children)

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

Adds the children of this StateObject to the given list.
public NullComparisonExpressionStateObject

Returns:

This object
addNot()

Makes sure the NOT identifier is specified.

public NullComparisonExpression
getExpression()

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
public StateObject

Returns:

The StateObject representing the collection-valued path expression
getStateObject()

Returns the StateObject representing the collection-valued path expression.

public boolean

Returns:

true if the NOT identifier is part of the expression; false otherwise
hasNot()

Determines whether the NOT identifier is used or not.

public boolean

Returns:

true if the StateObject is not null; false otherwise
hasStateObject()

Determines whether there is a StateObject representing the collection-valued path expression.

public boolean
isEquivalent(StateObject
The StateObject to compare its content to this one
stateObject)

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
private void
parse(String
Either a singled-valued path expression or an input parameter
path)

Parses the given singled-valued path expression or input parameter.

public void
removeNot()

Makes sure the NOT identifier is not specified.

public void
setExpression(NullComparisonExpression
The parsed object representing the null expression
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.

public void
setNot(boolean
true if the NOT identifier should be part of the expression; false otherwise
not)

Sets whether the NOT identifier should be part of the expression or not.

public void
setStateObject(StateObject
The StateObject that represents the collection-valued path expression
stateObject)

Sets the given StateObject as the collection-valued path expression.

public void
toggleNot()

Changes the visibility state of the NOT identifier.

protected void
toTextInternal(Appendable
The writer used to print out the string representation
writer)

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

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.
Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject:
acceptUnknownVisitoracceptUnknownVisitoraddProblemsaddPropertyChangeListenerareEquivalentbuildProblembuildProblembuildStateObjectbuildStateObjectscheckParentchildrendecorateequalsfindIdentificationVariablefirePropertyChangedgetChangeSupportgetDeclarationgetDecoratorgetGrammargetManagedTypeProvidergetParentgetQueryBuildergetRootgetTypegetTypegetTypeHelpergetTypeRepositoryhashCodeinitializeisDecoratedparentparentparentremovePropertyChangeListenersetExpressionsetParenttoStringtoStringtoStringInternaltoStringItemstoText

Field Detail

notback to summary
private boolean not

Determines whether the NOT identifier is part of the expression or not.

NOT_PROPERTYback to summary
public static final String NOT_PROPERTY

Notifies the visibility of the NOT identifier has changed.

STATE_OBJECT_PROPERTYback to summary
public static final String STATE_OBJECT_PROPERTY

Notifies the state object property has changed.

stateObjectback to summary
private StateObject stateObject

The StateObject representing the collection-valued path expression.

Constructor Detail

NullComparisonExpressionStateObjectback to summary
public NullComparisonExpressionStateObject(StateObject parent)

Creates a new NullComparisonExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

Exceptions
NullPointerException:
The given parent cannot be null
NullComparisonExpressionStateObjectback to summary
public NullComparisonExpressionStateObject(StateObject parent, boolean not, StateObject stateObject)

Creates a new NullComparisonExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

not:boolean

Determines whether the NOT identifier is part of the expression or not

stateObject:StateObject

The StateObject representing the collection-valued path expression

Exceptions
NullPointerException:
The given parent cannot be null
NullComparisonExpressionStateObjectback to summary
public NullComparisonExpressionStateObject(StateObject parent, boolean not, String path)

Creates a new NullComparisonExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

not:boolean

Determines whether the NOT identifier is part of the expression or not

path:String

Either the singled-valued path expression or the input parameter

Exceptions
NullPointerException:
The given parent cannot be null
NullComparisonExpressionStateObjectback to summary
public NullComparisonExpressionStateObject(StateObject parent, StateObject stateObject)

Creates a new NullComparisonExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

stateObject:StateObject

The StateObject representing the collection-valued path expression

Exceptions
NullPointerException:
The given parent cannot be null
NullComparisonExpressionStateObjectback to summary
public NullComparisonExpressionStateObject(StateObject parent, String path)

Creates a new NullComparisonExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

path:String

Either the singled-valued path expression or the input parameter

Exceptions
NullPointerException:
The given parent cannot be null

Method Detail

acceptback to summary
public void accept(StateObjectVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.

Parameters
visitor:StateObjectVisitor

The visitor to visit this object

Annotations
@Override
addChildrenback to summary
protected void addChildren(List<StateObject> children)

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

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Adds the children of this StateObject to the given list.

Parameters
children:List<StateObject>

The list used to store the children

Annotations
@Override
addNotback to summary
public NullComparisonExpressionStateObject addNot()

Makes sure the NOT identifier is specified.

Returns:NullComparisonExpressionStateObject

This object

getExpressionback to summary
public NullComparisonExpression getExpression()

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Returns:NullComparisonExpression

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)

Annotations
@Override
getStateObjectback to summary
public StateObject getStateObject()

Returns the StateObject representing the collection-valued path expression.

Returns:StateObject

The StateObject representing the collection-valued path expression

hasNotback to summary
public boolean hasNot()

Determines whether the NOT identifier is used or not.

Returns:boolean

true if the NOT identifier is part of the expression; false otherwise

hasStateObjectback to summary
public boolean hasStateObject()

Determines whether there is a StateObject representing the collection-valued path expression.

Returns:boolean

true if the StateObject is not null; false otherwise

isEquivalentback to summary
public boolean isEquivalent(StateObject stateObject)

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

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Parameters
stateObject:StateObject

The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations
@Override
parseback to summary
private void parse(String path)

Parses the given singled-valued path expression or input parameter.

Parameters
path:String

Either a singled-valued path expression or an input parameter

removeNotback to summary
public void removeNot()

Makes sure the NOT identifier is not specified.

setExpressionback to summary
public void setExpression(NullComparisonExpression 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:NullComparisonExpression

The parsed object representing the null expression

setNotback to summary
public void setNot(boolean not)

Sets whether the NOT identifier should be part of the expression or not.

Parameters
not:boolean

true if the NOT identifier should be part of the expression; false otherwise

setStateObjectback to summary
public void setStateObject(StateObject stateObject)

Sets the given StateObject as the collection-valued path expression.

Parameters
stateObject:StateObject

The StateObject that represents the collection-valued path expression

toggleNotback to summary
public void toggleNot()

Changes the visibility state of the NOT identifier.

toTextInternalback to summary
protected void toTextInternal(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.toTextInternal.

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.

Parameters
writer:Appendable

The writer used to print out the string representation

Annotations
@Override
Exceptions
IOException:
This should never happens, it is only required because Appendable is used instead of any concrete class