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

public abstract Class AbstractPartitioningMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.partitioning.FieldPartitioningMetadata, org.eclipse.persistence.internal.jpa.metadata.partitioning.PartitioningMetadata, org.eclipse.persistence.internal.jpa.metadata.partitioning.PinnedPartitioningMetadata, org.eclipse.persistence.internal.jpa.metadata.partitioning.ReplicationPartitioningMetadata
Imports
org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy, 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: 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.
Author
James Sutherland
Since
EclipseLink 2.2

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
AbstractPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
AbstractPartitioningMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
public abstract PartitioningPolicy
buildPolicy()

Require subclass to build policy.

public void
buildPolicy(PartitioningPolicy policy)

Set common fields into policy.

public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

Equals is used for processing overrides from XML.
public String
getName()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
setName(String name)

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

Field Detail

nameback to summary
protected String name

Constructor Detail

AbstractPartitioningMetadataback to summary
public AbstractPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

AbstractPartitioningMetadataback to summary
protected AbstractPartitioningMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Detail

buildPolicyback to summary
public abstract PartitioningPolicy buildPolicy()

Require subclass to build policy.

buildPolicyback to summary
public void buildPolicy(PartitioningPolicy policy)

Set common fields into policy. Should be called by subclasses.

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

Equals is used for processing overrides from XML.

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
getNameback to summary
public String getName()
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
setNameback to summary
public void setName(String name)