Class ConstructorExpressionStateObject
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<StateObject>
-
- org.eclipse.persistence.jpa.jpql.tools.model.query.ConstructorExpressionStateObject
-
- All Implemented Interfaces:
ListHolderStateObject<StateObject>
,StateObject
public class ConstructorExpressionStateObject extends AbstractListHolderStateObject<StateObject>
In theSELECT
clause a constructor may be used in theSELECT
list to return one or more Java instances. The specified class is not required to be an entity or to be mapped to the database. The constructor name must be fully qualified.BNF:constructor_expression ::= NEW constructor_name(constructor_item {, constructor_item}*)
- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
ConstructorExpression
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CLASS_NAME_PROPERTY
Notifies the class name property has changed.static java.lang.String
CONSTRUCTOR_ITEMS_LIST
Notify the list ofStateObjects
representing the constructor items.
-
Constructor Summary
Constructors Constructor Description ConstructorExpressionStateObject(StateObject parent)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.lang.String jpqlFragment)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.util.List<? extends StateObject> constructorItems)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.String className)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.lang.String jpqlFragment)
Creates a newConstructorExpressionStateObject
.ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.util.List<? extends StateObject> constructorItems)
Creates a newConstructorExpressionStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.java.lang.String
getClassName()
Returns the fully qualified class name that will be used to retrieve the constructor.ConstructorExpression
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.IType
getType()
Returns the actualIType
that was resolved ornull
if it could not be resolved.boolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.void
parse(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which represents the constructor's arguments.void
setClassName(java.lang.CharSequence className)
Sets the fully qualified class name that will be used to retrieve the constructor.void
setClassName(java.lang.Class<?> type)
Sets the fully qualified class name that will be used to retrieve the constructor.void
setExpression(ConstructorExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.void
setType(IType type)
Sets the actualIType
and updates the class name.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject
addItem, addItems, addListChangeListener, canMoveDown, canMoveUp, getItem, hasItems, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText
-
-
-
-
Field Detail
-
CLASS_NAME_PROPERTY
public static final java.lang.String CLASS_NAME_PROPERTY
Notifies the class name property has changed.- See Also:
- Constant Field Values
-
CONSTRUCTOR_ITEMS_LIST
public static final java.lang.String CONSTRUCTOR_ITEMS_LIST
Notify the list ofStateObjects
representing the constructor items.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
type
- The fully qualified name of the Java class to instantiate- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.util.List<? extends StateObject> constructorItems)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
type
- The Java class to instantiateconstructorItems
- The list of arguments- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.lang.String jpqlFragment)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
type
- The Java class to instantiatejpqlFragment
- The portion of the JPQL query that represents the constructor's arguments- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
className
- The fully qualified name of the Java class to instantiate- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.util.List<? extends StateObject> constructorItems)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
className
- The fully qualified name of the Java class to instantiateconstructorItems
- The list of arguments- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
ConstructorExpressionStateObject
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.lang.String jpqlFragment)
Creates a newConstructorExpressionStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
className
- The fully qualified name of the Java class to instantiatejpqlFragment
- The portion of the JPQL query that represents the constructor's arguments- Throws:
java.lang.NullPointerException
- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
getClassName
public java.lang.String getClassName()
Returns the fully qualified class name that will be used to retrieve the constructor.- Returns:
- The fully qualified class name or an empty string if it is not defined
-
getExpression
public ConstructorExpression getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getType
public IType getType()
Returns the actualIType
that was resolved ornull
if it could not be resolved.- Returns:
- The actual
IType
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Description copied from class:AbstractStateObject
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractStateObject
- Parameters:
stateObject
- TheStateObject
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 constructor's arguments.- Parameters:
jpqlFragment
- The JPQL fragment, which represents either a single or multiple arguments
-
setClassName
public void setClassName(java.lang.CharSequence className)
Sets the fully qualified class name that will be used to retrieve the constructor.- Parameters:
className
- The fully qualified class name
-
setClassName
public void setClassName(java.lang.Class<?> type)
Sets the fully qualified class name that will be used to retrieve the constructor.- Parameters:
type
- The type used to retrieve its fully qualified class name
-
setExpression
public void setExpression(ConstructorExpression expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing aNEW
expression
-
-