Package org.eclipse.persistence.internal.jpa.metadata.queries

Class SQLResultSetMappingMetadata

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.queries.SQLResultSetMappingMetadata

public class SQLResultSetMappingMetadata
extends ORMetadata

INTERNAL: Object to hold onto an sql result mapping metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - all metadata mapped from XML must be initialized in the initXMLObject method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

m_project

Constructor Summary

Constructors

Constructor	Description
SQLResultSetMappingMetadata()	INTERNAL: Used for XML loading.
SQLResultSetMappingMetadata(MetadataAnnotation sqlResultSetMapping, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.
SQLResultSetMappingMetadata(MetadataClass entityClass, MetadataAccessibleObject accessibleObject, MetadataProject project, Object location)	INTERNAL: Used for result class processing.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
List<ColumnResultMetadata>	getColumnResults()	INTERNAL: Used for OX mapping.
List<ConstructorResultMetadata>	getConstructorResults()	INTERNAL: Used for OX mapping.
List<EntityResultMetadata>	getEntityResults()	INTERNAL: Used for OX mapping.
String	getIdentifier()	INTERNAL:
String	getName()	INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
SQLResultSetMapping	process()	INTERNAL: Process an sql result set mapping metadata into a EclipseLink SqlResultSetMapping and store it on the session.
void	setColumnResults(List<ColumnResultMetadata> columnResults)	INTERNAL: Used for OX mapping.
void	setConstructorResults(List<ConstructorResultMetadata> constructorResults)	INTERNAL: Used for OX mapping.
void	setEntityResults(List<EntityResultMetadata> entityResults)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLResultSetMappingMetadata

public SQLResultSetMappingMetadata()

INTERNAL: Used for XML loading.

SQLResultSetMappingMetadata

public SQLResultSetMappingMetadata(MetadataAnnotation sqlResultSetMapping,
                                   MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

SQLResultSetMappingMetadata

public SQLResultSetMappingMetadata(MetadataClass entityClass,
                                   MetadataAccessibleObject accessibleObject,
                                   MetadataProject project,
                                   Object location)

INTERNAL: Used for result class processing.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getColumnResults

public List<ColumnResultMetadata> getColumnResults()

INTERNAL: Used for OX mapping.

getConstructorResults

public List<ConstructorResultMetadata> getConstructorResults()

INTERNAL: Used for OX mapping.

getEntityResults

public List<EntityResultMetadata> getEntityResults()

INTERNAL: Used for OX mapping.

getIdentifier

public String getIdentifier()

INTERNAL:

Overrides:

getIdentifier in class ORMetadata

See Also:

ORMetadata.shouldOverride(ORMetadata), ORMetadata.mergeORObjects(ORMetadata, ORMetadata), ORMetadata.mergeORObjectLists(List, List)

getName

public String getName()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

process

public SQLResultSetMapping process()

INTERNAL: Process an sql result set mapping metadata into a EclipseLink SqlResultSetMapping and store it on the session. The order of processing the results and adding them is important to be spec compliant.

setColumnResults

public void setColumnResults(List<ColumnResultMetadata> columnResults)

INTERNAL: Used for OX mapping.

setConstructorResults

public void setConstructorResults(List<ConstructorResultMetadata> constructorResults)

INTERNAL: Used for OX mapping.

setEntityResults

public void setEntityResults(List<EntityResultMetadata> entityResults)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.