Package org.eclipse.persistence.queries
Class ConstructorReportItem
- java.lang.Object
-
- org.eclipse.persistence.internal.queries.ReportItem
-
- org.eclipse.persistence.queries.ConstructorReportItem
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
public class ConstructorReportItem extends org.eclipse.persistence.internal.queries.ReportItem
Purpose: An item specifying a class constructor method to be used in a ReportQuery's returned results.Example:
ConstructorReportItem item = new ConstructorReportItem("Employee"); item.setResultType(Employee.class); item.addAttribute("firstName", employees.get("firstName")); query.addConstructorReportItem(item);
When executed will return a collection of ReportQueryResults that contain Employee objects created using the new Employee(firstname) constructor.
- Since:
- TopLink Essentials 1.0
- Author:
- Chris Delahunt
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ConstructorReportItem()
Create a new constructor item.ConstructorReportItem(java.lang.String name)
Create a new constructor item.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAttribute(java.lang.String attributeName, Expression attributeExpression, java.util.List joinedExpressions)
Add the attribute with joining.void
addAttribute(Expression attributeExpression)
Method to add an expression to be used to return the parameter that is then passed into the constructor method.void
addItem(org.eclipse.persistence.internal.queries.ReportItem item)
java.lang.reflect.Constructor
getConstructor()
INTERNAL: Return the constructor.java.lang.Class[]
getConstructorArgTypes()
java.util.List
getConstructorMappings()
INTERNAL: Return the mappings for the items.java.util.List
getReportItems()
void
initialize(ReportQuery query)
INTERNAL: Looks up mapping for attribute during preExecute of ReportQueryboolean
isConstructorItem()
void
setConstructor(java.lang.reflect.Constructor constructor)
INTERNAL: Set the constructor.void
setConstructorArgTypes(java.lang.Class[] constructorArgTypes)
void
setConstructorMappings(java.util.List constructorMappings)
INTERNAL: Return the mappings for the items.void
setReportItems(java.util.List reportItems)
java.lang.String
toString()
-
Methods inherited from class org.eclipse.persistence.internal.queries.ReportItem
clone, getAttributeExpression, getDescriptor, getJoinedAttributeManager, getJoinedAttributeManagerInternal, getMapping, getName, getResultIndex, getResultType, hasJoining, isPlaceHolder, setAttributeExpression, setDescriptor, setJoinedAttributeManager, setMapping, setResultIndex, setResultType
-
-
-
-
Method Detail
-
addAttribute
public void addAttribute(Expression attributeExpression)
Method to add an expression to be used to return the parameter that is then passed into the constructor method. Similar to ReportQuery's addAttribute method, but name is not needed.
-
addAttribute
public void addAttribute(java.lang.String attributeName, Expression attributeExpression, java.util.List joinedExpressions)
Add the attribute with joining.
-
addItem
public void addItem(org.eclipse.persistence.internal.queries.ReportItem item)
-
getConstructorArgTypes
public java.lang.Class[] getConstructorArgTypes()
-
getConstructorMappings
public java.util.List getConstructorMappings()
INTERNAL: Return the mappings for the items.
-
getConstructor
public java.lang.reflect.Constructor getConstructor()
INTERNAL: Return the constructor.
-
setConstructor
public void setConstructor(java.lang.reflect.Constructor constructor)
INTERNAL: Set the constructor.
-
getReportItems
public java.util.List getReportItems()
-
initialize
public void initialize(ReportQuery query) throws QueryException
INTERNAL: Looks up mapping for attribute during preExecute of ReportQuery- Overrides:
initialize
in classorg.eclipse.persistence.internal.queries.ReportItem
- Throws:
QueryException
-
isConstructorItem
public boolean isConstructorItem()
- Overrides:
isConstructorItem
in classorg.eclipse.persistence.internal.queries.ReportItem
-
setConstructorArgTypes
public void setConstructorArgTypes(java.lang.Class[] constructorArgTypes)
-
setConstructorMappings
public void setConstructorMappings(java.util.List constructorMappings)
INTERNAL: Return the mappings for the items.
-
setReportItems
public void setReportItems(java.util.List reportItems)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classorg.eclipse.persistence.internal.queries.ReportItem
-
-