Module org.eclipse.persistence.core

Package org.eclipse.persistence.queries

Class EntityResult

java.lang.Object

org.eclipse.persistence.queries.SQLResult

org.eclipse.persistence.queries.EntityResult

All Implemented Interfaces:

Serializable

public class EntityResult
extends SQLResult

Purpose: Concrete class to represent the EntityResult structure as defined by the EJB 3.0 Persistence specification. This class is a subcomponent of the SQLResultSetMapping

Since:

TopLink Java Essentials

Author:

Gordon Yorke

See Also:

SQLResultSetMapping, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseField	discriminatorColumn	Stores the column that will contain the value to determine the correct subclass to create if applicable.
protected Class<?>	entityClass
protected String	entityClassName	Stores the class name of result
protected Map	fieldResults	Stores the list of FieldResult

Fields inherited from class org.eclipse.persistence.queries.SQLResult

sqlResultSetMapping

Constructor Summary

Constructors

Constructor	Description
EntityResult(Class<?> entityClass)
EntityResult(String entityClassName)

Method Summary

Modifier and Type	Method	Description
void	addFieldResult(FieldResult fieldResult)
void	convertClassNamesToClasses(ClassLoader classLoader)	INTERNAL: Convert all the class-name-based settings in this query to actual class-based settings.
DatabaseField	getDiscriminatorColumn()	Returns the column name for the column that will store the value used to determine the subclass type if applicable.
Map	getFieldResults()	Accessor for the internally stored list of FieldResult.
Object	getValueFromRecord(DatabaseRecord record, ResultSetMappingQuery query)	INTERNAL: This method is a convenience method for extracting values from Results
void	getValueFromRecordForMapping(DatabaseRecord entityRecord, DatabaseMapping mapping, FieldResult fieldResult, DatabaseRecord databaseRecord)	INTERNAL: This method is for processing all FieldResults for a mapping.
boolean	isEntityResult()	Return true if this is an entity result.
DatabaseField	processValueFromRecordForMapping(ClassDescriptor descriptor, String[] attributeNames, int currentLoc)	INTERNAL: This method is for processing a single FieldResult, returning the DatabaseField it refers to.
void	setDiscriminatorColumn(String column)	Sets the column name for the column that will store the value used to determine the subclass type if applicable.
void	setDiscriminatorColumn(DatabaseField column)

Methods inherited from class org.eclipse.persistence.queries.SQLResult

getSQLResultMapping, isColumnResult, isConstructorResult, setSQLResultMapping

Methods inherited from class java.lang.Object

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

Field Detail

entityClassName

protected String entityClassName

Stores the class name of result

entityClass

protected transient Class<?> entityClass

fieldResults

protected Map fieldResults

Stores the list of FieldResult

discriminatorColumn

protected DatabaseField discriminatorColumn

Stores the column that will contain the value to determine the correct subclass to create if applicable.

Constructor Detail

EntityResult

public EntityResult(Class<?> entityClass)

EntityResult

public EntityResult(String entityClassName)

Method Detail

addFieldResult

public void addFieldResult(FieldResult fieldResult)

convertClassNamesToClasses

public void convertClassNamesToClasses(ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this query to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

Overrides:

convertClassNamesToClasses in class SQLResult

getFieldResults

public Map getFieldResults()

Accessor for the internally stored list of FieldResult. Calling this method will result in a collection being created to store the FieldResult

getDiscriminatorColumn

public DatabaseField getDiscriminatorColumn()

Returns the column name for the column that will store the value used to determine the subclass type if applicable.

setDiscriminatorColumn

public void setDiscriminatorColumn(String column)

Sets the column name for the column that will store the value used to determine the subclass type if applicable.

setDiscriminatorColumn

public void setDiscriminatorColumn(DatabaseField column)

getValueFromRecord

public Object getValueFromRecord(DatabaseRecord record,
                                 ResultSetMappingQuery query)

INTERNAL: This method is a convenience method for extracting values from Results

Specified by:

getValueFromRecord in class SQLResult

isEntityResult

public boolean isEntityResult()

Description copied from class: SQLResult

Return true if this is an entity result.

Overrides:

isEntityResult in class SQLResult

getValueFromRecordForMapping

public void getValueFromRecordForMapping(DatabaseRecord entityRecord,
                                         DatabaseMapping mapping,
                                         FieldResult fieldResult,
                                         DatabaseRecord databaseRecord)

INTERNAL: This method is for processing all FieldResults for a mapping. Adds DatabaseFields to the passed in entityRecord

processValueFromRecordForMapping

public DatabaseField processValueFromRecordForMapping(ClassDescriptor descriptor,
                                                      String[] attributeNames,
                                                      int currentLoc)

INTERNAL: This method is for processing a single FieldResult, returning the DatabaseField it refers to.