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

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 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.

BNF: constructor_expression ::= NEW constructor_name(constructor_item {, constructor_item}*)

Since:
2.4
Version:
2.4
See Also:

  • Field Details

  • Constructor Details

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, Class<?> type)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      type - The fully qualified name of the Java class to instantiate
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, Class<?> type, List<? extends StateObject> constructorItems)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      type - The Java class to instantiate
      constructorItems - The list of arguments
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, Class<?> type, String jpqlFragment)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      type - The Java class to instantiate
      jpqlFragment - The portion of the JPQL query that represents the constructor's arguments
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, String className)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      className - The fully qualified name of the Java class to instantiate
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, String className, List<? extends StateObject> constructorItems)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      className - The fully qualified name of the Java class to instantiate
      constructorItems - The list of arguments
      Throws:
      NullPointerException - The given parent cannot be null

    • ConstructorExpressionStateObject

      public ConstructorExpressionStateObject(StateObject parent, String className, String jpqlFragment)
      Creates a new ConstructorExpressionStateObject.
      Parameters:
      parent - The parent of this state object, which cannot be null
      className - The fully qualified name of the Java class to instantiate
      jpqlFragment - The portion of the JPQL query that represents the constructor's arguments
      Throws:
      NullPointerException - The given parent cannot be null

  • Method Details

    • accept

      public void accept(StateObjectVisitor visitor)
      Description copied from interface: StateObject
      Visits this StateObject by the given visitor.
      Parameters:
      visitor - The visitor to visit this object

    • getClassName

      public 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()
      Description copied from interface: StateObject
      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)

    • getType

      public IType getType()
      Returns the actual IType that was resolved or null if it could not be resolved.
      Returns:
      The actual IType

    • isEquivalent

      public boolean isEquivalent(StateObject stateObject)
      Description copied from interface: 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

    • listName

      protected String listName()
      Description copied from class: AbstractListHolderStateObject
      Returns the name that is uniquely identifying the list.
      Specified by:
      listName in class AbstractListHolderStateObject<StateObject>
      Returns:
      The unique name identifying the list

    • parse

      public void parse(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

    • resolveType

      protected IType resolveType()
      Resolves the actual IType based on the class name.
      Returns:
      The IType with the fully qualified class name

    • setClassName

      public void setClassName(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(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

    • setClassNameInternally

      protected void setClassNameInternally(CharSequence className)
      Sets the fully qualified class name that will be used to retrieve the constructor.
      Parameters:
      className - The fully qualified class name

    • setExpression

      public 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.
      Parameters:
      expression - The parsed object representing a NEW expression

    • setType

      public void setType(IType type)
      Sets the actual IType and updates the class name.
      Parameters:
      type - The new IType

    • toTextInternal

      protected void toTextInternal(Appendable writer) throws IOException
      Description copied from class: AbstractStateObject
      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:
      IOException - This should never happens, it is only required because Appendable is used instead of any concrete class