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

public abstract Class FieldPartitioningMetadata

extends AbstractPartitioningMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.partitioning.HashPartitioningMetadata, org.eclipse.persistence.internal.jpa.metadata.partitioning.RangePartitioningMetadata, org.eclipse.persistence.internal.jpa.metadata.partitioning.ValuePartitioningMetadata
Imports
org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy, .PartitioningPolicy, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.columns.ColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings
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 ColumnMetadata
partitionColumn

protected MetadataClass
partitionValueType

protected String
partitionValueTypeName

protected Boolean
unionUnpartitionableQueries

Inherited from org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata:
name

Constructor Summary

AccessConstructor and Description
public
FieldPartitioningMetadata()

INTERNAL: Used for XML loading.

public
FieldPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
FieldPartitioningMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
public void
buildPolicy(PartitioningPolicy policy)

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.buildPolicy.

Set common fields into policy.
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.equals.

INTERNAL: Used for XML merging and overriding.
public ColumnMetadata
getPartitionColumn()

INTERNAL: Used for OX mapping.

public MetadataClass
getPartitionValueType()

INTERNAL:

public String
getPartitionValueTypeName()

INTERNAL: Used for OX mapping.

public Boolean
getUnionUnpartitionableQueries()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.hashCode.

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
setPartitionColumn(ColumnMetadata partitionColumn)

INTERNAL: Used for OX mapping.

public void
setPartitionValueTypeName(String partitionValueTypeName)

INTERNAL: Used for OX mapping.

public void
setUnionUnpartitionableQueries(Boolean unionUnpartitionableQueries)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata:
buildPolicygetNamesetName

Field Detail

partitionColumnback to summary
protected ColumnMetadata partitionColumn
partitionValueTypeback to summary
protected MetadataClass partitionValueType
partitionValueTypeNameback to summary
protected String partitionValueTypeName
unionUnpartitionableQueriesback to summary
protected Boolean unionUnpartitionableQueries

Constructor Detail

FieldPartitioningMetadataback to summary
public FieldPartitioningMetadata()

INTERNAL: Used for XML loading.

FieldPartitioningMetadataback to summary
public FieldPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

FieldPartitioningMetadataback to summary
protected FieldPartitioningMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Detail

buildPolicyback to summary
public void buildPolicy(PartitioningPolicy policy)

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.buildPolicy.

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

Annotations
@Override
equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.equals.

INTERNAL: Used for XML merging and overriding.

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
getPartitionColumnback to summary
public ColumnMetadata getPartitionColumn()

INTERNAL: Used for OX mapping.

getPartitionValueTypeback to summary
public MetadataClass getPartitionValueType()

INTERNAL:

getPartitionValueTypeNameback to summary
public String getPartitionValueTypeName()

INTERNAL: Used for OX mapping.

getUnionUnpartitionableQueriesback to summary
public Boolean getUnionUnpartitionableQueries()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.partitioning.AbstractPartitioningMetadata.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
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
setPartitionColumnback to summary
public void setPartitionColumn(ColumnMetadata partitionColumn)

INTERNAL: Used for OX mapping.

setPartitionValueTypeNameback to summary
public void setPartitionValueTypeName(String partitionValueTypeName)

INTERNAL: Used for OX mapping.

setUnionUnpartitionableQueriesback to summary
public void setUnionUnpartitionableQueries(Boolean unionUnpartitionableQueries)

INTERNAL: Used for OX mapping.