PrimaryKeyMetadata (EclipseLink JPA 4.0.0 API)

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.ORMetadata
- - org.eclipse.persistence.internal.jpa.metadata.columns.PrimaryKeyMetadata

```
public class PrimaryKeyMetadata
extends ORMetadata
```
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.

Since:

EclipseLink 1.1

Author:

James Sutherland

See Also:

PrimaryKey

Field Summary
- Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
  m_project

Constructor Summary

Constructors
Constructor	Description
`PrimaryKeyMetadata()`	INTERNAL: Used for XML loading.
`PrimaryKeyMetadata(MetadataAnnotation primaryKey, MetadataAccessor accessor)`	INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	INTERNAL:
`String`	`getCacheKeyType()`	INTERNAL: Used for OX mapping.
`List<ColumnMetadata>`	`getColumns()`	INTERNAL: Used for OX mapping.
`String`	`getValidation()`	INTERNAL: Used for OX mapping.
`boolean`	`hasColumns()`	INTERNAL:
`int`	`hashCode()`
`void`	`process(MetadataDescriptor descriptor)`	Process the meta-data, configure primary key and idValidation in descriptor.
`void`	`setCacheKeyType(String cacheKeyType)`	INTERNAL: Used for OX mapping.
`void`	`setColumns(List<ColumnMetadata> columns)`	INTERNAL: Used for OX mapping.
`void`	`setValidation(String validation)`	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, 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

PrimaryKeyMetadata
```
public PrimaryKeyMetadata()
```
INTERNAL: Used for XML loading.

PrimaryKeyMetadata

public PrimaryKeyMetadata(MetadataAnnotation primaryKey,
                          MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail
- equals
```
public boolean equals(Object objectToCompare)
```
  INTERNAL:
  
  Specified by:
  
  equals in class ORMetadata
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- getCacheKeyType
```
public String getCacheKeyType()
```
  INTERNAL: Used for OX mapping.
- getColumns
```
public List<ColumnMetadata> getColumns()
```
  INTERNAL: Used for OX mapping.
- getValidation
```
public String getValidation()
```
  INTERNAL: Used for OX mapping.
- hasColumns
```
public boolean hasColumns()
```
  INTERNAL:
- process
```
public void process(MetadataDescriptor descriptor)
```
  Process the meta-data, configure primary key and idValidation in descriptor.
- setCacheKeyType
```
public void setCacheKeyType(String cacheKeyType)
```
  INTERNAL: Used for OX mapping.
- setColumns
```
public void setColumns(List<ColumnMetadata> columns)
```
  INTERNAL: Used for OX mapping.
- setValidation
```
public void setValidation(String validation)
```
  INTERNAL: Used for OX mapping.