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

public Class EntityResultMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.List, .ArrayList, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.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.EntityResult
INTERNAL: Object to hold onto an entity result 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 String
m_discriminatorColumn

private MetadataClass
m_entityClass

private String
m_entityClassName

private List<FieldResultMetadata>
m_fieldResults

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

Constructor Summary

AccessConstructor and Description
public
EntityResultMetadata()

INTERNAL: Used for XML loading.

public
EntityResultMetadata(MetadataAnnotation entityResult, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

public
EntityResultMetadata(MetadataClass entityClass, MetadataAccessibleObject accessibleObject)

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 String
getDiscriminatorColumn()

INTERNAL: Used for OX mapping.

public MetadataClass
getEntityClass()

INTERNAL:

public String
getEntityClassName()

INTERNAL: Used for OX mapping.

public List<FieldResultMetadata>
getFieldResults()

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 EntityResult
process()

INTERNAL: Process the entity result for the given sql result set mapping.

public void
setDiscriminatorColumn(String discriminatorColumn)

INTERNAL: Used for OX mapping.

public void
setEntityClass(MetadataClass entityClass)

INTERNAL:

public void
setEntityClassName(String entityClassName)

INTERNAL: Used for OX mapping.

public void
setFieldResults(List<FieldResultMetadata> fieldResults)

INTERNAL: Used for OX mapping.

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

Field Detail

m_discriminatorColumnback to summary
private String m_discriminatorColumn
m_entityClassback to summary
private MetadataClass m_entityClass
m_entityClassNameback to summary
private String m_entityClassName
m_fieldResultsback to summary
private List<FieldResultMetadata> m_fieldResults

Constructor Detail

EntityResultMetadataback to summary
public EntityResultMetadata()

INTERNAL: Used for XML loading.

EntityResultMetadataback to summary
public EntityResultMetadata(MetadataAnnotation entityResult, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

EntityResultMetadataback to summary
public EntityResultMetadata(MetadataClass entityClass, MetadataAccessibleObject accessibleObject)

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
getDiscriminatorColumnback to summary
public String getDiscriminatorColumn()

INTERNAL: Used for OX mapping.

getEntityClassback to summary
public MetadataClass getEntityClass()

INTERNAL:

getEntityClassNameback to summary
public String getEntityClassName()

INTERNAL: Used for OX mapping.

getFieldResultsback to summary
public List<FieldResultMetadata> getFieldResults()

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 EntityResult process()

INTERNAL: Process the entity result for the given sql result set mapping.

setDiscriminatorColumnback to summary
public void setDiscriminatorColumn(String discriminatorColumn)

INTERNAL: Used for OX mapping.

setEntityClassback to summary
public void setEntityClass(MetadataClass entityClass)

INTERNAL:

setEntityClassNameback to summary
public void setEntityClassName(String entityClassName)

INTERNAL: Used for OX mapping.

setFieldResultsback to summary
public void setFieldResults(List<FieldResultMetadata> fieldResults)

INTERNAL: Used for OX mapping.