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

Class NotExpressionStateObject

java.lang.Object

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

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

All Implemented Interfaces:

StateObject

public class NotExpressionStateObject
extends AbstractStateObject

BNF: expression ::= NOT conditional_primary

Version:

2.4

See Also:

NotExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STATE_OBJECT_PROPERTY	Notifies the state object property has changed.

Constructor Summary

Constructors

Constructor	Description
NotExpressionStateObject(StateObject parent)	Creates a new NotExpressionStateObject.
NotExpressionStateObject(StateObject parent, java.lang.String jpqlFragment)	Creates a new NotExpressionStateObject.
NotExpressionStateObject(StateObject parent, StateObject stateObject)	Creates a new NotExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
protected void	addChildren(java.util.List<StateObject> children)	Adds the children of this StateObject to the given list.
NotExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
StateObject	getStateObject()	Returns the StateObject representing the negated expression.
boolean	hasStateObject()	Determines whether the StateObject representing the encapsulated expression is present or not.
boolean	isEquivalent(StateObject stateObject)	Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
void	parse(java.lang.String jpqlFragment)	Parses the given JPQL fragment, which represents the negated expression, and creates the StateObject.
void	setExpression(NotExpression 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.
void	setStateObject(StateObject stateObject)	Sets the given StateObject as the new negated expression.
protected void	toTextInternal(java.lang.Appendable writer)	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.

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

Field Detail

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

NotExpressionStateObject

public NotExpressionStateObject(StateObject parent)

Creates a new NotExpressionStateObject.

Parameters:

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

Throws:

java.lang.NullPointerException - The given parent cannot be null

NotExpressionStateObject

public NotExpressionStateObject(StateObject parent,
                                StateObject stateObject)

Creates a new NotExpressionStateObject.

Parameters:

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

stateObject - The StateObject representing the negated expression

Throws:

java.lang.NullPointerException - The given parent cannot be null

NotExpressionStateObject

public NotExpressionStateObject(StateObject parent,
                                java.lang.String jpqlFragment)

Creates a new NotExpressionStateObject.

Parameters:

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

jpqlFragment - The portion of the JPQL query that follows NOT, which will be parsed and converted into a StateObject

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

addChildren

protected void addChildren(java.util.List<StateObject> children)

Adds the children of this StateObject to the given list.

Overrides:

addChildren in class AbstractStateObject

Parameters:

children - The list used to store the children

getExpression

public NotExpression getExpression()

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)

getStateObject

public StateObject getStateObject()

Returns the StateObject representing the negated expression.

Returns:

The StateObject representing the negated expression

hasStateObject

public boolean hasStateObject()

Determines whether the StateObject representing the encapsulated expression is present or not.

Returns:

true if the encapsulated StateObject is not null; false otherwise

isEquivalent

public boolean isEquivalent(StateObject stateObject)

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

Specified by:

isEquivalent in interface StateObject

Overrides:

isEquivalent in class AbstractStateObject

Parameters:

stateObject - The StateObject to compare its content to this one

Returns:

true if both object are equivalent; false otherwise

parse

public void parse(java.lang.String jpqlFragment)

Parses the given JPQL fragment, which represents the negated expression, and creates the StateObject.

Parameters:

jpqlFragment - The portion of the query representing the negated expression

setExpression

public void setExpression(NotExpression 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 NOT expression

setStateObject

public void setStateObject(StateObject stateObject)

Sets the given StateObject as the new negated expression.

Parameters:

stateObject - The StateObject representing the negated expression

toTextInternal

protected void toTextInternal(java.lang.Appendable writer)
                       throws java.io.IOException

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.

Specified by:

toTextInternal in class AbstractStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class