Package org.eclipse.persistence.internal.queries

Class ReportItem

java.lang.Object

org.eclipse.persistence.internal.queries.ReportItem

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ConstructorReportItem

public class ReportItem
extends Object
implements Cloneable, Serializable

Purpose: represents an item requested (i.e. field for SELECT)

Since:

2.0

Author:

Doug Clarke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	attributeExpression	Expression (partial) describing the attribute wanted
protected ClassDescriptor	descriptor	Descriptor for object result that is not based on an expression
protected JoinedAttributeManager	joinedAttributeManager	Stores the Join information for this item
protected DatabaseMapping	mapping	Mapping which relates field to attribute, used to convert value and determine reference descriptor
protected String	name	Name given for item, can be used to retrieve value from result.
protected int	resultIndex	Stores the row index for this item, given multiple results and joins
protected Class	resultType	Result type for this report item.

Constructor Summary

Constructors

Constructor	Description
ReportItem()
ReportItem(String name, Expression attributeExpression)

Method Summary

Modifier and Type	Method	Description
Object	clone()
Expression	getAttributeExpression()
ClassDescriptor	getDescriptor()
JoinedAttributeManager	getJoinedAttributeManager()	INTERNAL: Set the list of expressions that represent elements that are joined because of their mapping for this query.
JoinedAttributeManager	getJoinedAttributeManagerInternal()
DatabaseMapping	getMapping()
String	getName()
int	getResultIndex()
Class	getResultType()
boolean	hasJoining()	INTERNAL: Return if any attributes are joined.
void	initialize(ReportQuery query)	INTERNAL: Looks up mapping for attribute during preExecute of ReportQuery
boolean	isConstructorItem()
void	setAttributeExpression(Expression attributeExpression)
void	setDescriptor(ClassDescriptor descriptor)
void	setJoinedAttributeManager(JoinedAttributeManager joinManager)
void	setMapping(DatabaseMapping mapping)
void	setResultIndex(int resultIndex)
void	setResultType(Class resultType)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

attributeExpression

protected Expression attributeExpression

Expression (partial) describing the attribute wanted

name

protected String name

Name given for item, can be used to retrieve value from result. Useful if same field retrieved multiple times

mapping

protected DatabaseMapping mapping

Mapping which relates field to attribute, used to convert value and determine reference descriptor

descriptor

protected ClassDescriptor descriptor

Descriptor for object result that is not based on an expression

resultType

protected Class resultType

Result type for this report item.

joinedAttributeManager

protected JoinedAttributeManager joinedAttributeManager

Stores the Join information for this item

resultIndex

protected int resultIndex

Stores the row index for this item, given multiple results and joins

Constructor Detail

ReportItem

public ReportItem()

ReportItem

public ReportItem(String name,
                  Expression attributeExpression)

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getAttributeExpression

public Expression getAttributeExpression()

setAttributeExpression

public void setAttributeExpression(Expression attributeExpression)

getDescriptor

public ClassDescriptor getDescriptor()

getJoinedAttributeManager

public JoinedAttributeManager getJoinedAttributeManager()

INTERNAL: Set the list of expressions that represent elements that are joined because of their mapping for this query.

getJoinedAttributeManagerInternal

public JoinedAttributeManager getJoinedAttributeManagerInternal()

hasJoining

public boolean hasJoining()

INTERNAL: Return if any attributes are joined. To avoid the initialization of the JoinedAttributeManager this should be first checked before accessing.

getMapping

public DatabaseMapping getMapping()

getName

public String getName()

getResultIndex

public int getResultIndex()

getResultType

public Class getResultType()

initialize

public void initialize(ReportQuery query)
                throws QueryException

INTERNAL: Looks up mapping for attribute during preExecute of ReportQuery

Throws:

QueryException

isConstructorItem

public boolean isConstructorItem()

setDescriptor

public void setDescriptor(ClassDescriptor descriptor)

setJoinedAttributeManager

public void setJoinedAttributeManager(JoinedAttributeManager joinManager)

setMapping

public void setMapping(DatabaseMapping mapping)

setResultIndex

public void setResultIndex(int resultIndex)

setResultType

public void setResultType(Class resultType)

toString

public String toString()

Overrides:

toString in class Object