|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.model.query.AbstractStateObject
org.eclipse.persistence.jpa.jpql.model.query.AbstractListHolderStateObject<StateObject>
org.eclipse.persistence.jpa.jpql.model.query.ConstructorExpressionStateObject
public class ConstructorExpressionStateObject
In the SELECT
clause a constructor may be used in the SELECT
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.
constructor_expression ::= NEW constructor_name(constructor_item {, constructor_item}*)
ConstructorExpression
Field Summary | |
---|---|
static java.lang.String |
CLASS_NAME_PROPERTY
Notifies the class name property has changed. |
static java.lang.String |
CONSTRUCTOR_ITEMS_LIST
Notify the list of StateObjects representing the constructor items. |
Constructor Summary | |
---|---|
ConstructorExpressionStateObject(StateObject parent)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.Class<?> type)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.Class<?> type,
java.util.List<? extends StateObject> constructorItems)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.Class<?> type,
java.lang.String jpqlFragment)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.String className)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.String className,
java.util.List<? extends StateObject> constructorItems)
Creates a new ConstructorExpressionStateObject . |
|
ConstructorExpressionStateObject(StateObject parent,
java.lang.String className,
java.lang.String jpqlFragment)
Creates a new ConstructorExpressionStateObject . |
Method Summary | |
---|---|
void |
accept(StateObjectVisitor visitor)
Visits this StateObject by the given visitor . |
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 this StateObject representation of the JPQL query
was created by parsing an existing JPQL query. |
IType |
getType()
Returns the actual IType that was resolved or null if it could not be resolved. |
boolean |
isEquivalent(StateObject stateObject)
Determines whether the given StateObject is equivalent to this one, i.e. the
information of both StateObject is the same. |
protected java.lang.String |
listName()
Returns the name that is uniquely identifying the list. |
void |
parse(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which represents the constructor's arguments. |
protected IType |
resolveType()
Resolves the actual IType based on the class name. |
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. |
protected void |
setClassNameInternally(java.lang.CharSequence className)
Sets the fully qualified class name that will be used to retrieve the constructor. |
void |
setExpression(ConstructorExpression 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 |
setType(IType type)
Sets the actual IType and updates the class name. |
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.model.query.AbstractListHolderStateObject |
---|
addChildren, addItem, addItems, addListChangeListener, areChildrenEquivalent, canMoveDown, canMoveUp, getItem, hasItems, initialize, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener, toStringItems |
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, 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 |
Methods inherited from interface org.eclipse.persistence.jpa.jpql.model.query.StateObject |
---|
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText |
Field Detail |
---|
public static final java.lang.String CLASS_NAME_PROPERTY
public static final java.lang.String CONSTRUCTOR_ITEMS_LIST
StateObjects
representing the constructor items.
Constructor Detail |
---|
public ConstructorExpressionStateObject(StateObject parent)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
type
- The fully qualified name of the Java class to instantiate
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.util.List<? extends StateObject> constructorItems)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
type
- The Java class to instantiateconstructorItems
- The list of arguments
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.Class<?> type, java.lang.String jpqlFragment)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
type
- The Java class to instantiatejpqlFragment
- The portion of the JPQL query that represents the constructor's arguments
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
className
- The fully qualified name of the Java class to instantiate
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.util.List<? extends StateObject> constructorItems)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
className
- The fully qualified name of the Java class to instantiateconstructorItems
- The list of arguments
java.lang.NullPointerException
- The given parent cannot be null
public ConstructorExpressionStateObject(StateObject parent, java.lang.String className, java.lang.String jpqlFragment)
ConstructorExpressionStateObject
.
parent
- The parent of this state object, which cannot be null
className
- The fully qualified name of the Java class to instantiatejpqlFragment
- The portion of the JPQL query that represents the constructor's arguments
java.lang.NullPointerException
- The given parent cannot be null
Method Detail |
---|
public void accept(StateObjectVisitor visitor)
StateObject
by the given visitor
.
visitor
- The visitor
to visit this objectpublic java.lang.String getClassName()
public ConstructorExpression getExpression()
StateObject
representation of the JPQL query
was created by parsing an existing JPQL query.
getExpression
in interface StateObject
getExpression
in class AbstractStateObject
StateObject
or null
when the JPQL query is manually created (i.e. not from a string)public IType getType()
IType
that was resolved or null
if it could not be resolved.
IType
public boolean isEquivalent(StateObject stateObject)
AbstractStateObject
StateObject
is equivalent to this one, i.e. the
information of both StateObject
is the same.
isEquivalent
in interface StateObject
isEquivalent
in class AbstractStateObject
stateObject
- The StateObject
to compare its content to this one
true
if both object are equivalent; false
otherwiseprotected java.lang.String listName()
listName
in class AbstractListHolderStateObject<StateObject>
public void parse(java.lang.String jpqlFragment)
jpqlFragment
- The JPQL fragment, which represents either a single or multiple argumentsprotected IType resolveType()
IType
based on the class name.
IType
with the fully qualified class namepublic void setClassName(java.lang.CharSequence className)
className
- The fully qualified class namepublic void setClassName(java.lang.Class<?> type)
type
- The type used to retrieve its fully qualified class nameprotected void setClassNameInternally(java.lang.CharSequence className)
className
- The fully qualified class namepublic void setExpression(ConstructorExpression expression)
parsed object
object, which should only
be done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects
.
expression
- The parsed object
representing a NEW
expressionpublic void setType(IType type)
protected void toTextInternal(java.lang.Appendable writer) throws java.io.IOException
StateObject
, which should not be used to
define a true
string representation of a JPQL query but should be used for
debugging purposes.
toTextInternal
in class AbstractStateObject
writer
- The writer used to print out the string representation
java.io.IOException
- This should never happens, it is only required because Appendable
is used instead of any concrete class
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |