oracle.toplink.essentials.queryframework

Class ConstructorReportItem

java.lang.Object

oracle.toplink.essentials.internal.queryframework.ReportItem

oracle.toplink.essentials.queryframework.ConstructorReportItem

All Implemented Interfaces:

java.io.Serializable

public class ConstructorReportItem
extends ReportItem

Purpose: An item specifying a class constructor method to be used in a ReportQuery's returned results. Example: ConstructorReportItem citem = new ConstructorReportItem("Employee"); citem.setResultType(Employee.class); citem.addAttribute("firstName", employees.get("firstName")); query.addConstructorReportItem(citem); when executed will return a collection of ReportQueryResults that contain Employee objects created using the new Employee(firstname) method.

Since:

TopLink Essentials

Author:

Chris Delahunt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class[]	constructorArgTypes
protected java.util.List	constructorMappings
java.util.List	reportItems

Fields inherited from class oracle.toplink.essentials.internal.queryframework.ReportItem

attributeExpression, descriptor, joinManager, mapping, name, resultIndex, resultType

Constructor Summary

Constructors

Constructor and Description
ConstructorReportItem()
ConstructorReportItem(java.lang.String name) Method to add an expression to be used to return the parameter that is then passed into the constructor method.

Method Summary

Modifier and Type	Method and Description
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	addAttribute(java.lang.String attributeName, Expression attributeExpression, java.util.List joinedExpressions)
void	addItem(ReportItem item)
java.lang.Class[]	getConstructorArgTypes()
java.util.List	getConstructorMappings()
java.util.List	getReportItems()
void	initialize(ReportQuery query) INTERNAL: Looks up mapping for attribute during preExecute of ReportQuery
boolean	isContructorItem()
void	setConstructorArgTypes(java.lang.Class[] constructorArgTypes)
void	setConstructorMappings(java.util.List constructorMappings)
void	setReportItems(java.util.List reportItems)
java.lang.String	toString()

Methods inherited from class oracle.toplink.essentials.internal.queryframework.ReportItem

getAttributeExpression, getDescriptor, getJoinedAttributeManager, getMapping, getName, getResultIndex, getResultType, isPlaceHolder, setDescriptor, setMapping, setResultIndex, setResultType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

constructorArgTypes

protected java.lang.Class[] constructorArgTypes

constructorMappings

protected java.util.List constructorMappings

reportItems

public java.util.List reportItems

Constructor Detail

ConstructorReportItem

public ConstructorReportItem()

ConstructorReportItem

public ConstructorReportItem(java.lang.String name)

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 a name is not needed

Parameters:

name - - string used to look up this result in the ReportQueryResult

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 a name is not needed

Parameters:

attributeExpression -

addAttribute

public void addAttribute(java.lang.String attributeName,
                         Expression attributeExpression,
                         java.util.List joinedExpressions)

addItem

public void addItem(ReportItem item)

getConstructorArgTypes

public java.lang.Class[] getConstructorArgTypes()

getConstructorMappings

public java.util.List getConstructorMappings()

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 class ReportItem

Throws:

QueryException

isContructorItem

public boolean isContructorItem()

Overrides:

isContructorItem in class ReportItem

setConstructorArgTypes

public void setConstructorArgTypes(java.lang.Class[] constructorArgTypes)

setConstructorMappings

public void setConstructorMappings(java.util.List constructorMappings)

setReportItems

public void setReportItems(java.util.List reportItems)

toString

public java.lang.String toString()

Overrides:

toString in class ReportItem