AbstractPartitioningMetadata (EclipseLink JPA 4.0.6 API)

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.ORMetadata
- - org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata

Direct Known Subclasses:

FieldPartitioningMetadata, PartitioningMetadata, PinnedPartitioningMetadata, ReplicationPartitioningMetadata
```
public abstract class AbstractPartitioningMetadata
extends ORMetadata
```
INTERNAL: Define JPA meta-data for partitioning policy. 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 2.2

Author:

James Sutherland

Field Summary

Fields
Modifier and Type Field Description

protected String name
- Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
  m_project

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractPartitioningMetadata(String elementName)`	INTERNAL: Used for XML loading.
	`AbstractPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor)`	INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract PartitioningPolicy`	`buildPolicy()`	Require subclass to build policy.
`void`	`buildPolicy(PartitioningPolicy policy)`	Set common fields into policy.
`boolean`	`equals(Object objectToCompare)`	Equals is used for processing overrides from XML.
`String`	`getName()`
`int`	`hashCode()`
`void`	`setName(String name)`

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

Field Detail
- name
```
protected String name
```

Constructor Detail

AbstractPartitioningMetadata

public AbstractPartitioningMetadata(MetadataAnnotation annotation,
                                    MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

AbstractPartitioningMetadata

protected AbstractPartitioningMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Detail
- getName
```
public String getName()
```
- setName
```
public void setName(String name)
```
- equals
```
public boolean equals(Object objectToCompare)
```
  Equals is used for processing overrides from XML.
  
  Specified by:
  
  equals in class ORMetadata
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- buildPolicy
```
public abstract PartitioningPolicy buildPolicy()
```
  Require subclass to build policy.
- buildPolicy
```
public void buildPolicy(PartitioningPolicy policy)
```
  Set common fields into policy. Should be called by subclasses.