EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql.model.query
Class SizeExpressionStateObject

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
      extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractEncapsulatedExpressionStateObject
          extended by org.eclipse.persistence.jpa.jpql.model.query.AbstractSingleEncapsulatedExpressionStateObject
              extended by org.eclipse.persistence.jpa.jpql.model.query.SizeExpressionStateObject
All Implemented Interfaces:
StateObject

public class SizeExpressionStateObject
extends AbstractSingleEncapsulatedExpressionStateObject

The SIZE function returns an integer value, the number of elements of the collection. If the collection is empty, the SIZE function evaluates to zero.

BNF: expression ::= SIZE(collection_valued_path_expression)

Version:
2.4
See Also:
SizeExpression
Author:
Pascal Filion
Since:
2.4

Field Summary
 
Fields inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractSingleEncapsulatedExpressionStateObject
STATE_OBJECT_PROPERTY
 
Constructor Summary
SizeExpressionStateObject(StateObject parent)
          Creates a new SizeExpressionStateObject.
SizeExpressionStateObject(StateObject parent, StateObject stateObject)
          Creates a new SizeExpressionStateObject.
SizeExpressionStateObject(StateObject parent, java.lang.String path)
          Creates a new SizeExpressionStateObject.
 
Method Summary
 void accept(StateObjectVisitor visitor)
          Visits this StateObject by the given visitor.
 SizeExpression getExpression()
          Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
 java.lang.String getIdentifier()
          Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
protected  java.lang.String getQueryBNFId()
          Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.
 void setExpression(SizeExpression 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 to represent the new encapsulated expression.
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractSingleEncapsulatedExpressionStateObject
addChildren, getStateObject, hasStateObject, isEquivalent, parse, toTextEncapsulatedExpression
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.model.query.AbstractEncapsulatedExpressionStateObject
toTextInternal
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.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
 

Constructor Detail

SizeExpressionStateObject

public SizeExpressionStateObject(StateObject parent)
Creates a new SizeExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
Throws:
java.lang.NullPointerException - The given parent cannot be null

SizeExpressionStateObject

public SizeExpressionStateObject(StateObject parent,
                                 StateObject stateObject)
Creates a new SizeExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
stateObject - The StateObject representing the encapsulated expression
Throws:
java.lang.NullPointerException - The given parent cannot be null

SizeExpressionStateObject

public SizeExpressionStateObject(StateObject parent,
                                 java.lang.String path)
Creates a new SizeExpressionStateObject.

Parameters:
parent - The parent of this state object, which cannot be null
path - The collection-valued path expression
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

getExpression

public SizeExpression 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 AbstractSingleEncapsulatedExpressionStateObject
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)

getIdentifier

public java.lang.String getIdentifier()
Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.

Specified by:
getIdentifier in class AbstractEncapsulatedExpressionStateObject
Returns:
The JPQL identifier that is shown before the left parenthesis

getQueryBNFId

protected java.lang.String getQueryBNFId()
Returns the unique identifier of the JPQLQueryBNF that will determine how to parse the encapsulated expression.

Specified by:
getQueryBNFId in class AbstractSingleEncapsulatedExpressionStateObject
Returns:
The non-null ID of the BNF

setExpression

public void setExpression(SizeExpression 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 SIZE expression

setStateObject

public void setStateObject(StateObject stateObject)
Sets the given StateObject to represent the new encapsulated expression.

Overrides:
setStateObject in class AbstractSingleEncapsulatedExpressionStateObject
Parameters:
stateObject - The new encapsulated StateObject

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference