EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

Modifier and Type	Field and Description
private String	m_access
private AccessMethodsMetadata	m_accessMethods
private List<ConverterMetadata>	m_converters
private MetadataDescriptor	m_descriptor
private HashPartitioningMetadata	m_hashPartitioning
private String	m_name
private List<ObjectTypeConverterMetadata>	m_objectTypeConverters
private String	m_partitioned
private PartitioningMetadata	m_partitioning
private PinnedPartitioningMetadata	m_pinnedPartitioning
private List<PropertyMetadata>	m_properties
private RangePartitioningMetadata	m_rangePartitioning
private ReplicationPartitioningMetadata	m_replicationPartitioning
private RoundRobinPartitioningMetadata	m_roundRobinPartitioning
private List<SerializedConverterMetadata>	m_serializedConverters
private List<StructConverterMetadata>	m_structConverters
private List<TypeConverterMetadata>	m_typeConverters
private UnionPartitioningMetadata	m_unionPartitioning
private ValuePartitioningMetadata	m_valuePartitioning

Access	Constructor and Description
public	MetadataAccessor(String xmlElement) INTERNAL: Used for OX mapping.
public	MetadataAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, MetadataDescriptor descriptor, MetadataProject project) INTERNAL:

Method Summary

Modifier and Type	Method 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	getAccess() INTERNAL: Used for OX mapping.
public MetadataAnnotatedElement	getAccessibleObject() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getAccessibleObject. INTERNAL: Returns the accessible object for this accessor.
public AccessMethodsMetadata	getAccessMethods() INTERNAL: Used for OX mapping.
public MetadataAnnotatedElement	getAnnotatedElement() INTERNAL: Return the annotated element for this accessor.
public String	getAnnotatedElementName() INTERNAL: Return the annotated element name for this accessor.
public MetadataAnnotation	getAnnotation(Class<?> annotation) INTERNAL: Return the annotation if it exists.
protected abstract MetadataAnnotation	getAnnotation(String annotation) INTERNAL: Return the annotation if it exists.
public String	getAttributeName() INTERNAL: Return the attribute name for this accessor.
public List<ConverterMetadata>	getConverters() INTERNAL: Used for OX mapping.
protected String	getDefaultAttributeName() INTERNAL: Return the upper cased attribute name for this accessor.
public MetadataDescriptor	getDescriptor() INTERNAL: Return the MetadataDescriptor for this accessor.
public MetadataClass	getDescriptorJavaClass() INTERNAL: Return the java class tied to this class accessor's descriptor.
public HashPartitioningMetadata	getHashPartitioning() INTERNAL: Used for OX mapping.
public String	getIdentifier() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier. INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
public MetadataClass	getJavaClass() INTERNAL: Return the java class associated with this accessor's descriptor.
protected String	getJavaClassName() INTERNAL: Return the java class that defines this accessor.
public String	getName() INTERNAL: Used for OX mapping.
public List<ObjectTypeConverterMetadata>	getObjectTypeConverters() INTERNAL: Used for OX mapping.
public String	getPartitioned() INTERNAL: Used for OX mapping.
public PartitioningMetadata	getPartitioning() INTERNAL: Used for OX mapping.
public PinnedPartitioningMetadata	getPinnedPartitioning() INTERNAL: Used for OX mapping.
public List<PropertyMetadata>	getProperties() INTERNAL: Used for OX mapping.
public RangePartitioningMetadata	getRangePartitioning() INTERNAL: Used for OX mapping.
protected DatabaseField	getReferencedField(String referencedColumnName, MetadataDescriptor referenceDescriptor, String context) INTERNAL: Return the referenced field.
protected DatabaseField	getReferencedField(String referencedColumnName, MetadataDescriptor referenceDescriptor, String context, boolean isForAggregateCollection) INTERNAL: Return the referenced field.
public ReplicationPartitioningMetadata	getReplicationPartitioning() INTERNAL: Used for OX mapping.
public RoundRobinPartitioningMetadata	getRoundRobinPartitioning() INTERNAL: Used for OX mapping.
public List<SerializedConverterMetadata>	getSerializedConverters() INTERNAL: Used for OX mapping.
public List<StructConverterMetadata>	getStructConverters() INTERNAL: Used for OX mapping.
public List<TypeConverterMetadata>	getTypeConverters() INTERNAL: Used for OX mapping.
public UnionPartitioningMetadata	getUnionPartitioning() INTERNAL: Used for OX mapping.
protected String	getUpperCaseShortJavaClassName() INTERNAL: Return the upper case java class that defines this accessor.
protected Integer	getValue(Integer value, Integer defaultValue) INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.
protected String	getValue(String value, String defaultValue) INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.
public ValuePartitioningMetadata	getValuePartitioning() INTERNAL: Used for OX mapping.
public boolean	hasAccess() INTERNAL:
public boolean	hasAccessMethods() INTERNAL:
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public void	initAccess() INTERNAL: Called from annotation and xml initialization.
public void	initXMLAccessor(MetadataDescriptor descriptor, MetadataProject project) INTERNAL: This method should be subclassed in those methods that need to do extra initialization.
public void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.initXMLObject. INTERNAL:
public boolean	isAnnotationPresent(Class<? extends Annotation> annotation) INTERNAL: Return true if the annotation exists.
public abstract boolean	isAnnotationPresent(String annotation) INTERNAL: Return the annotation if it exists.
public abstract boolean	isProcessed() Subclasses must handle this flag.
public void	merge(ORMetadata metadata) Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.merge. INTERNAL: We currently limit this merging to the ClassAccessor level.
public abstract void	process() INTERNAL: Every accessor knows how to process themselves since they have all the information they need.
public void	processConverters() INTERNAL: Process and add the globally defined converters to the project.
protected void	processCustomConverters() INTERNAL: Process the XML defined converters and check for a Converter annotation.
protected void	processObjectTypeConverters() INTERNAL: Process the XML defined object type converters and check for an ObjectTypeConverter annotation.
public void	processPartitioned(String name) Set the policy on the descriptor or mapping.
protected void	processPartitioning() Process the partitioning policies defined on this element.
protected List<PrimaryKeyJoinColumnMetadata>	processPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns) INTERNAL: Process the primary key join columms for this accessors annotated element.
protected void	processSerializedConverters() INTERNAL: Process a the XML defined serialized converters and check for a SerializedConverter annotation.
protected void	processStructConverters() INTERNAL: Process the XML defined struct converters and check for a StructConverter annotation.
protected void	processTable(TableMetadata table, String defaultName) INTERNAL: Common table processing for table, secondary table, join table and collection table.
protected void	processTypeConverters() INTERNAL: Process a the XML defined type converters and check for a TypeConverter annotation.
public void	setAccess(String access) INTERNAL: Used for OX mapping.
public void	setAccessMethods(AccessMethodsMetadata accessMethods) INTERNAL: Used for OX mapping.
public void	setConverters(List<ConverterMetadata> converters) INTERNAL: Used for OX mapping.
public void	setDescriptor(MetadataDescriptor descriptor) INTERNAL: Set the metadata descriptor for this accessor.
public void	setHashPartitioning(HashPartitioningMetadata hashPartitioning) INTERNAL: Used for OX mapping.
public void	setName(String name) INTERNAL: Used for OX mapping.
public void	setObjectTypeConverters(List<ObjectTypeConverterMetadata> objectTypeConverters) INTERNAL: Used for OX mapping.
public void	setPartitioned(String partitioned) INTERNAL: Used for OX mapping.
public void	setPartitioning(PartitioningMetadata partitioning) INTERNAL: Used for OX mapping.
public void	setPinnedPartitioning(PinnedPartitioningMetadata pinnedPartitioning) INTERNAL: Used for OX mapping.
public void	setProperties(List<PropertyMetadata> properties) INTERNAL: Used for OX mapping.
public void	setRangePartitioning(RangePartitioningMetadata rangePartitioning) INTERNAL: Used for OX mapping.
public void	setReplicationPartitioning(ReplicationPartitioningMetadata replicationPartitioning) INTERNAL: Used for OX mapping.
public void	setRoundRobinPartitioning(RoundRobinPartitioningMetadata roundRobinPartitioning) INTERNAL: Used for OX mapping.
public void	setSerializedConverters(List<SerializedConverterMetadata> serializedConverters) INTERNAL: Used for OX mapping.
public void	setStructConverters(List<StructConverterMetadata> structConverters) INTERNAL: Used for OX mapping.
public void	setTypeConverters(List<TypeConverterMetadata> typeConverters) INTERNAL: Used for OX mapping.
public void	setUnionPartitioning(UnionPartitioningMetadata unionPartitioning) INTERNAL: Used for OX mapping.
public void	setValuePartitioning(ValuePartitioningMetadata valuePartitioning) INTERNAL: Used for OX mapping.

m_access	back to summary
private String m_access

m_accessMethods	back to summary
private AccessMethodsMetadata m_accessMethods

m_converters	back to summary
private List<ConverterMetadata> m_converters

m_descriptor	back to summary
private MetadataDescriptor m_descriptor

m_hashPartitioning	back to summary
private HashPartitioningMetadata m_hashPartitioning

m_name	back to summary
private String m_name

m_objectTypeConverters	back to summary
private List<ObjectTypeConverterMetadata> m_objectTypeConverters

m_partitioned	back to summary
private String m_partitioned

m_partitioning	back to summary
private PartitioningMetadata m_partitioning

m_pinnedPartitioning	back to summary
private PinnedPartitioningMetadata m_pinnedPartitioning

m_properties	back to summary
private List<PropertyMetadata> m_properties

m_rangePartitioning	back to summary
private RangePartitioningMetadata m_rangePartitioning

m_replicationPartitioning	back to summary
private ReplicationPartitioningMetadata m_replicationPartitioning

m_roundRobinPartitioning	back to summary
private RoundRobinPartitioningMetadata m_roundRobinPartitioning

m_serializedConverters	back to summary
private List<SerializedConverterMetadata> m_serializedConverters

m_structConverters	back to summary
private List<StructConverterMetadata> m_structConverters

m_typeConverters	back to summary
private List<TypeConverterMetadata> m_typeConverters

m_unionPartitioning	back to summary
private UnionPartitioningMetadata m_unionPartitioning

m_valuePartitioning	back to summary
private ValuePartitioningMetadata m_valuePartitioning

Method Detail

equals back to summary

equals	back 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

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

getAccess	back to summary
public String getAccess() INTERNAL: Used for OX mapping.

getAccessibleObject	back to summary
public MetadataAnnotatedElement getAccessibleObject() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getAccessibleObject. INTERNAL: Returns the accessible object for this accessor. Annotations @Override

getAccessibleObject

back to summary

public MetadataAnnotatedElement getAccessibleObject()

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

INTERNAL: Returns the accessible object for this accessor.

Annotations

@Override

getAccessMethods	back to summary
public AccessMethodsMetadata getAccessMethods() INTERNAL: Used for OX mapping.

getAnnotatedElement	back to summary
public MetadataAnnotatedElement getAnnotatedElement() INTERNAL: Return the annotated element for this accessor.

getAnnotatedElementName	back to summary
public String getAnnotatedElementName() INTERNAL: Return the annotated element name for this accessor.

getAnnotation	back to summary
public MetadataAnnotation getAnnotation(Class<?> annotation) INTERNAL: Return the annotation if it exists. This method should only be called for non JPA annotations as loading those annotations classes is ok (and available). JPA annotations should be referenced only by name as to not introduce a compile dependency.

getAnnotation	back to summary
protected abstract MetadataAnnotation getAnnotation(String annotation) INTERNAL: Return the annotation if it exists.

getAttributeName	back to summary
public String getAttributeName() INTERNAL: Return the attribute name for this accessor.

getConverters	back to summary
public List<ConverterMetadata> getConverters() INTERNAL: Used for OX mapping.

getDefaultAttributeName	back to summary
protected String getDefaultAttributeName() INTERNAL: Return the upper cased attribute name for this accessor. Used when defaulting.

getDescriptor	back to summary
public MetadataDescriptor getDescriptor() INTERNAL: Return the MetadataDescriptor for this accessor.

getDescriptorJavaClass	back to summary
public MetadataClass getDescriptorJavaClass() INTERNAL: Return the java class tied to this class accessor's descriptor.

getHashPartitioning	back to summary
public HashPartitioningMetadata getHashPartitioning() INTERNAL: Used for OX mapping.

getIdentifier	back to summary
public String getIdentifier() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier. INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata. Annotations @Override

getIdentifier

back to summary

public String getIdentifier()

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

INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.

Annotations

@Override

getJavaClass	back to summary
public MetadataClass getJavaClass() INTERNAL: Return the java class associated with this accessor's descriptor.

getJavaClassName	back to summary
protected String getJavaClassName() INTERNAL: Return the java class that defines this accessor.

getName	back to summary
public String getName() INTERNAL: Used for OX mapping.

getObjectTypeConverters	back to summary
public List<ObjectTypeConverterMetadata> getObjectTypeConverters() INTERNAL: Used for OX mapping.

getPartitioned	back to summary
public String getPartitioned() INTERNAL: Used for OX mapping.

getPartitioning	back to summary
public PartitioningMetadata getPartitioning() INTERNAL: Used for OX mapping.

getPinnedPartitioning	back to summary
public PinnedPartitioningMetadata getPinnedPartitioning() INTERNAL: Used for OX mapping.

getProperties	back to summary
public List<PropertyMetadata> getProperties() INTERNAL: Used for OX mapping.

getRangePartitioning	back to summary
public RangePartitioningMetadata getRangePartitioning() INTERNAL: Used for OX mapping.

getReferencedField	back to summary
protected DatabaseField getReferencedField(String referencedColumnName, MetadataDescriptor referenceDescriptor, String context) INTERNAL: Return the referenced field. If the referencedColumnName is not specified, it will default to the primary key of the referenced table.

getReferencedField	back to summary
protected DatabaseField getReferencedField(String referencedColumnName, MetadataDescriptor referenceDescriptor, String context, boolean isForAggregateCollection) INTERNAL: Return the referenced field. If the referencedColumnName is not specified, it will default to the primary key of the referenced table.

getReplicationPartitioning	back to summary
public ReplicationPartitioningMetadata getReplicationPartitioning() INTERNAL: Used for OX mapping.

getRoundRobinPartitioning	back to summary
public RoundRobinPartitioningMetadata getRoundRobinPartitioning() INTERNAL: Used for OX mapping.

getSerializedConverters	back to summary
public List<SerializedConverterMetadata> getSerializedConverters() INTERNAL: Used for OX mapping.

getStructConverters	back to summary
public List<StructConverterMetadata> getStructConverters() INTERNAL: Used for OX mapping.

getTypeConverters	back to summary
public List<TypeConverterMetadata> getTypeConverters() INTERNAL: Used for OX mapping.

getUnionPartitioning	back to summary
public UnionPartitioningMetadata getUnionPartitioning() INTERNAL: Used for OX mapping.

getUpperCaseShortJavaClassName	back to summary
protected String getUpperCaseShortJavaClassName() INTERNAL: Return the upper case java class that defines this accessor.

getValue	back to summary
protected Integer getValue(Integer value, Integer defaultValue) INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.

getValue	back to summary
protected String getValue(String value, String defaultValue) INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.

getValuePartitioning	back to summary
public ValuePartitioningMetadata getValuePartitioning() INTERNAL: Used for OX mapping.

hasAccess	back to summary
public boolean hasAccess() INTERNAL:

hasAccessMethods	back to summary
public boolean hasAccessMethods() INTERNAL:

hashCode back 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

initAccess	back to summary
public void initAccess() INTERNAL: Called from annotation and xml initialization.

initXMLAccessor	back to summary
public void initXMLAccessor(MetadataDescriptor descriptor, MetadataProject project) INTERNAL: This method should be subclassed in those methods that need to do extra initialization.

initXMLObject

back to summary

public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations

@Override

isAnnotationPresent	back to summary
public boolean isAnnotationPresent(Class<? extends Annotation> annotation) INTERNAL: Return true if the annotation exists. This method should only be called for non native annotations (i.e. JPA) as loading native annotations classes is ok since we know they are available from the jar. JPA annotations should be referenced only by name as to not introduce a compile dependency.

isAnnotationPresent	back to summary
public abstract boolean isAnnotationPresent(String annotation) INTERNAL: Return the annotation if it exists.

isProcessed	back to summary
public abstract boolean isProcessed() Subclasses must handle this flag.

merge

back to summary

public void merge(ORMetadata metadata)

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

INTERNAL: We currently limit this merging to the ClassAccessor level.

Annotations

@Override

process	back to summary
public abstract void process() INTERNAL: Every accessor knows how to process themselves since they have all the information they need.

processConverters	back to summary
public void processConverters() INTERNAL: Process and add the globally defined converters to the project.

processCustomConverters	back to summary
protected void processCustomConverters() INTERNAL: Process the XML defined converters and check for a Converter annotation.

processObjectTypeConverters	back to summary
protected void processObjectTypeConverters() INTERNAL: Process the XML defined object type converters and check for an ObjectTypeConverter annotation.

processPartitioned	back to summary
public void processPartitioned(String name) Set the policy on the descriptor or mapping.

processPartitioning	back to summary
protected void processPartitioning() Process the partitioning policies defined on this element.

processPrimaryKeyJoinColumns	back to summary
protected List<PrimaryKeyJoinColumnMetadata> processPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns) INTERNAL: Process the primary key join columms for this accessors annotated element.

processSerializedConverters	back to summary
protected void processSerializedConverters() INTERNAL: Process a the XML defined serialized converters and check for a SerializedConverter annotation.

processStructConverters	back to summary
protected void processStructConverters() INTERNAL: Process the XML defined struct converters and check for a StructConverter annotation.

processTable	back to summary
protected void processTable(TableMetadata table, String defaultName) INTERNAL: Common table processing for table, secondary table, join table and collection table.

processTypeConverters	back to summary
protected void processTypeConverters() INTERNAL: Process a the XML defined type converters and check for a TypeConverter annotation.

setAccess	back to summary
public void setAccess(String access) INTERNAL: Used for OX mapping.

setAccessMethods	back to summary
public void setAccessMethods(AccessMethodsMetadata accessMethods) INTERNAL: Used for OX mapping.

setConverters	back to summary
public void setConverters(List<ConverterMetadata> converters) INTERNAL: Used for OX mapping.

setDescriptor	back to summary
public void setDescriptor(MetadataDescriptor descriptor) INTERNAL: Set the metadata descriptor for this accessor. When setting the descriptor on entities, the owning descriptor is set to this descriptor.

setHashPartitioning	back to summary
public void setHashPartitioning(HashPartitioningMetadata hashPartitioning) INTERNAL: Used for OX mapping.

setName	back to summary
public void setName(String name) INTERNAL: Used for OX mapping.

setObjectTypeConverters	back to summary
public void setObjectTypeConverters(List<ObjectTypeConverterMetadata> objectTypeConverters) INTERNAL: Used for OX mapping.

setPartitioned	back to summary
public void setPartitioned(String partitioned) INTERNAL: Used for OX mapping.

setPartitioning	back to summary
public void setPartitioning(PartitioningMetadata partitioning) INTERNAL: Used for OX mapping.

setPinnedPartitioning	back to summary
public void setPinnedPartitioning(PinnedPartitioningMetadata pinnedPartitioning) INTERNAL: Used for OX mapping.

setProperties	back to summary
public void setProperties(List<PropertyMetadata> properties) INTERNAL: Used for OX mapping.

setRangePartitioning	back to summary
public void setRangePartitioning(RangePartitioningMetadata rangePartitioning) INTERNAL: Used for OX mapping.

setReplicationPartitioning	back to summary
public void setReplicationPartitioning(ReplicationPartitioningMetadata replicationPartitioning) INTERNAL: Used for OX mapping.

setRoundRobinPartitioning	back to summary
public void setRoundRobinPartitioning(RoundRobinPartitioningMetadata roundRobinPartitioning) INTERNAL: Used for OX mapping.

setSerializedConverters	back to summary
public void setSerializedConverters(List<SerializedConverterMetadata> serializedConverters) INTERNAL: Used for OX mapping.

setStructConverters	back to summary
public void setStructConverters(List<StructConverterMetadata> structConverters) INTERNAL: Used for OX mapping.

setTypeConverters	back to summary
public void setTypeConverters(List<TypeConverterMetadata> typeConverters) INTERNAL: Used for OX mapping.

setUnionPartitioning	back to summary
public void setUnionPartitioning(UnionPartitioningMetadata unionPartitioning) INTERNAL: Used for OX mapping.

setValuePartitioning	back to summary
public void setValuePartitioning(ValuePartitioningMetadata valuePartitioning) INTERNAL: Used for OX mapping.

public abstract Class MetadataAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail