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

public Class PrimaryKeyMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.ArrayList, .List, org.eclipse.persistence.annotations.CacheKeyType, .IdValidation, .PrimaryKey, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.columns.ColumnMetadata
Object to hold onto primary key metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals 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
James Sutherland
Since
EclipseLink 1.1
See Also
PrimaryKey

Field Summary

Modifier and TypeField and Description
private String
m_cacheKeyType

private List<ColumnMetadata>
m_columns

private String
m_validation

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

Constructor Summary

AccessConstructor and Description
public
PrimaryKeyMetadata()

INTERNAL: Used for XML loading.

public
PrimaryKeyMetadata(MetadataAnnotation primaryKey, 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
getCacheKeyType()

INTERNAL: Used for OX mapping.

public List<ColumnMetadata>
getColumns()

INTERNAL: Used for OX mapping.

public String
getValidation()

INTERNAL: Used for OX mapping.

public boolean
hasColumns()

INTERNAL:

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(MetadataDescriptor descriptor)

Process the meta-data, configure primary key and idValidation in descriptor.

public void
setCacheKeyType(String cacheKeyType)

INTERNAL: Used for OX mapping.

public void
setColumns(List<ColumnMetadata> columns)

INTERNAL: Used for OX mapping.

public void
setValidation(String validation)

INTERNAL: Used for OX mapping.

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

Field Detail

m_cacheKeyTypeback to summary
private String m_cacheKeyType
m_columnsback to summary
private List<ColumnMetadata> m_columns
m_validationback to summary
private String m_validation

Constructor Detail

PrimaryKeyMetadataback to summary
public PrimaryKeyMetadata()

INTERNAL: Used for XML loading.

PrimaryKeyMetadataback to summary
public PrimaryKeyMetadata(MetadataAnnotation primaryKey, 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
getCacheKeyTypeback to summary
public String getCacheKeyType()

INTERNAL: Used for OX mapping.

getColumnsback to summary
public List<ColumnMetadata> getColumns()

INTERNAL: Used for OX mapping.

getValidationback to summary
public String getValidation()

INTERNAL: Used for OX mapping.

hasColumnsback to summary
public boolean hasColumns()

INTERNAL:

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
processback to summary
public void process(MetadataDescriptor descriptor)

Process the meta-data, configure primary key and idValidation in descriptor.

setCacheKeyTypeback to summary
public void setCacheKeyType(String cacheKeyType)

INTERNAL: Used for OX mapping.

setColumnsback to summary
public void setColumns(List<ColumnMetadata> columns)

INTERNAL: Used for OX mapping.

setValidationback to summary
public void setValidation(String validation)

INTERNAL: Used for OX mapping.