Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.queries

public Class SQLResultSetMappingMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.ArrayList, .List, org.eclipse.persistence.internal.jpa.metadata.MetadataProject, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.queries.SQLResultSetMapping
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.
Author
Guy Pelletier
Since
TopLink EJB 3.0 Reference Implementation

Field Summary

Modifier and TypeField and Description
private List<ColumnResultMetadata>
m_columnResults

private List<ConstructorResultMetadata>
m_constructorResults

private List<EntityResultMetadata>
m_entityResults

private String
m_name

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
SQLResultSetMappingMetadata()

INTERNAL: Used for XML loading.

public
SQLResultSetMappingMetadata(MetadataAnnotation sqlResultSetMapping, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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

INTERNAL: Used for result class processing.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public List<ColumnResultMetadata>
getColumnResults()

INTERNAL: Used for OX mapping.

public List<ConstructorResultMetadata>
getConstructorResults()

INTERNAL: Used for OX mapping.

public List<EntityResultMetadata>
getEntityResults()

INTERNAL: Used for OX mapping.

public String
getIdentifier()

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

INTERNAL:
public String
getName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public SQLResultSetMapping
process()

INTERNAL: Process an sql result set mapping metadata into a EclipseLink SqlResultSetMapping and store it on the session.

public void
setColumnResults(List<ColumnResultMetadata> columnResults)

INTERNAL: Used for OX mapping.

public void
setConstructorResults(List<ConstructorResultMetadata> constructorResults)

INTERNAL: Used for OX mapping.

public void
setEntityResults(List<EntityResultMetadata> entityResults)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_columnResultsback to summary
private List<ColumnResultMetadata> m_columnResults
m_constructorResultsback to summary
private List<ConstructorResultMetadata> m_constructorResults
m_entityResultsback to summary
private List<EntityResultMetadata> m_entityResults
m_nameback to summary
private String m_name

Constructor Detail

SQLResultSetMappingMetadataback to summary
public SQLResultSetMappingMetadata()

INTERNAL: Used for XML loading.

SQLResultSetMappingMetadataback to summary
public SQLResultSetMappingMetadata(MetadataAnnotation sqlResultSetMapping, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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

INTERNAL: Used for result class processing.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getColumnResultsback to summary
public List<ColumnResultMetadata> getColumnResults()

INTERNAL: Used for OX mapping.

getConstructorResultsback to summary
public List<ConstructorResultMetadata> getConstructorResults()

INTERNAL: Used for OX mapping.

getEntityResultsback to summary
public List<EntityResultMetadata> getEntityResults()

INTERNAL: Used for OX mapping.

getIdentifierback to summary
public String getIdentifier()

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

INTERNAL:

Annotations
@Override
getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
processback to summary
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.

setColumnResultsback to summary
public void setColumnResults(List<ColumnResultMetadata> columnResults)

INTERNAL: Used for OX mapping.

setConstructorResultsback to summary
public void setConstructorResults(List<ConstructorResultMetadata> constructorResults)

INTERNAL: Used for OX mapping.

setEntityResultsback to summary
public void setEntityResults(List<EntityResultMetadata> entityResults)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.