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

public abstract Class ComplexTypeMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.queries.OracleComplexTypeMetadata, org.eclipse.persistence.internal.jpa.metadata.queries.PLSQLComplexTypeMetadata
Imports
org.eclipse.persistence.internal.helper.ComplexDatabaseType, org.eclipse.persistence.internal.jpa.metadata.ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Object to hold onto complex type meta-data, including PL/SQL records and collections, as well as advanced Oracle JDBC types. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - all metadata mapped from XML should 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
David McCann
Since
EclipseLink 2.5

Field Summary

Modifier and TypeField and Description
protected String
name

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

Constructor Summary

AccessConstructor and Description
public
ComplexTypeMetadata(String element)

INTERNAL: Used for XML loading.

public
ComplexTypeMetadata(MetadataAnnotation record, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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
getIdentifier()

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

INTERNAL: The unique identifier of named subgraph metadata.
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 boolean
isOracleComplexTypeMetadata()

Indicates an instance of OracleComplexTypeMetadata.

public boolean
isPLSQLComplexTypeMetadata()

Indicates an instance of PLSQLComplexTypeMetadata.

public abstract ComplexDatabaseType
process()

Build a runtime type from the meta-data.

protected void
process(ComplexDatabaseType type)

Build a runtime record type from the meta-data.

public void
setName(String name)

INTERNAL: Used for OX mapping.

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

Field Detail

nameback to summary
protected String name

Constructor Detail

ComplexTypeMetadataback to summary
public ComplexTypeMetadata(String element)

INTERNAL: Used for XML loading.

ComplexTypeMetadataback to summary
public ComplexTypeMetadata(MetadataAnnotation record, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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
getIdentifierback to summary
public String getIdentifier()

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

INTERNAL: The unique identifier of named subgraph metadata.

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
isOracleComplexTypeMetadataback to summary
public boolean isOracleComplexTypeMetadata()

Indicates an instance of OracleComplexTypeMetadata.

isPLSQLComplexTypeMetadataback to summary
public boolean isPLSQLComplexTypeMetadata()

Indicates an instance of PLSQLComplexTypeMetadata.

processback to summary
public abstract ComplexDatabaseType process()

Build a runtime type from the meta-data.

processback to summary
protected void process(ComplexDatabaseType type)

Build a runtime record type from the meta-data.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.