Top Methods
org.eclipse.persistence.internal.oxm.mappings

public Interface Mapping<ABSTRACT_SESSION extends CoreAbstractSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform<CONVERSION_MANAGER extends CoreConversionManager>, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager<SESSION_EVENT_LISTENER extends CoreSessionEventListener>>, ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, CONTAINER_POLICY extends CoreContainerPolicy<ABSTRACT_SESSION extends CoreAbstractSession>, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField, XML_RECORD extends XMLRecord>

Known Direct Subinterfaces
org.eclipse.persistence.internal.oxm.mappings.ObjectReferenceMapping, org.eclipse.persistence.internal.oxm.mappings.TransformationMapping, org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping, org.eclipse.persistence.oxm.mappings.XMLMapping, org.eclipse.persistence.internal.oxm.mappings.AnyAttributeMapping, org.eclipse.persistence.internal.oxm.mappings.AnyCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.AnyObjectMapping, org.eclipse.persistence.internal.oxm.mappings.BinaryDataCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.BinaryDataMapping, org.eclipse.persistence.internal.oxm.mappings.ChoiceCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.ChoiceObjectMapping, org.eclipse.persistence.internal.oxm.mappings.CompositeObjectMapping, org.eclipse.persistence.internal.oxm.mappings.DirectCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.DirectMapping, org.eclipse.persistence.internal.oxm.mappings.FragmentCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.FragmentMapping, org.eclipse.persistence.internal.oxm.mappings.InverseReferenceMapping
Imports
java.util.Map, org.eclipse.persistence.core.descriptors.CoreDescriptor, org.eclipse.persistence.core.mappings.CoreAttributeAccessor, org.eclipse.persistence.internal.core.helper.CoreField, org.eclipse.persistence.internal.core.queries.CoreContainerPolicy, org.eclipse.persistence.internal.core.sessions.CoreAbstractSession, org.eclipse.persistence.internal.oxm.record.XMLRecord

Method Summary

Modifier and TypeMethod and Description
public void
convertClassNamesToClasses(ClassLoader classLoader)

public ATTRIBUTE_ACCESSOR
getAttributeAccessor()

public Class<?>
getAttributeClassification()

The classification type for the attribute this mapping represents

public String
getAttributeName()

Return the name of the attribute set in the mapping.

public Object
getAttributeValueFromObject(Object object)

public CONTAINER_POLICY
getContainerPolicy()

public DESCRIPTOR
getDescriptor()

Return the descriptor to which this mapping belongs

public FIELD
getField()

public DESCRIPTOR
getReferenceDescriptor()

public boolean
isAbstractCompositeCollectionMapping()

Related mapping should implement this method to return true.

public boolean
isAbstractCompositeDirectCollectionMapping()

Related mapping should implement this method to return true.

public boolean
isAbstractCompositeObjectMapping()

Related mapping should implement this method to return true.

public boolean
isAbstractDirectMapping()

Related mapping should implement this method to return true.

public boolean
isCollectionMapping()

public boolean
isReadOnly()

public boolean
isReferenceMapping()

public boolean
isTransformationMapping()

Related mapping should implement this method to return true.

public void
setAttributeAccessor(ATTRIBUTE_ACCESSOR attributeAccessor)

ADVANCED: Set the attributeAccessor.

public void
setAttributeName(String attributeName)

Sets the name of the attribute in the mapping.

public void
setAttributeValueInObject(Object object, Object value)

public void
setGetMethodName(String methodName)

This method is invoked reflectively on the reference object to return the value of the attribute in the object.

public void
setIsReadOnly(boolean aBoolean)

Set this mapping to be read only.

public void
setProperties(Map<K, V> properties)

INTERNAL: Allow user defined properties.

public void
setSetMethodName(String methodName)

Set the methodName used to set the value for the mapping's attribute into the object.

public void
writeSingleValue(Object value, Object object, XML_RECORD record, ABSTRACT_SESSION session)

Method Detail

convertClassNamesToClassesback to summary
public void convertClassNamesToClasses(ClassLoader classLoader)
getAttributeAccessorback to summary
public ATTRIBUTE_ACCESSOR getAttributeAccessor()
getAttributeClassificationback to summary
public Class<?> getAttributeClassification()

The classification type for the attribute this mapping represents

getAttributeNameback to summary
public String getAttributeName()

Return the name of the attribute set in the mapping.

getAttributeValueFromObjectback to summary
public Object getAttributeValueFromObject(Object object)
getContainerPolicyback to summary
public CONTAINER_POLICY getContainerPolicy()
getDescriptorback to summary
public DESCRIPTOR getDescriptor()

Return the descriptor to which this mapping belongs

getFieldback to summary
public FIELD getField()
getReferenceDescriptorback to summary
public DESCRIPTOR getReferenceDescriptor()
isAbstractCompositeCollectionMappingback to summary
public boolean isAbstractCompositeCollectionMapping()

Related mapping should implement this method to return true.

isAbstractCompositeDirectCollectionMappingback to summary
public boolean isAbstractCompositeDirectCollectionMapping()

Related mapping should implement this method to return true.

isAbstractCompositeObjectMappingback to summary
public boolean isAbstractCompositeObjectMapping()

Related mapping should implement this method to return true.

isAbstractDirectMappingback to summary
public boolean isAbstractDirectMapping()

Related mapping should implement this method to return true.

isCollectionMappingback to summary
public boolean isCollectionMapping()
isReadOnlyback to summary
public boolean isReadOnly()
isReferenceMappingback to summary
public boolean isReferenceMapping()
isTransformationMappingback to summary
public boolean isTransformationMapping()

Related mapping should implement this method to return true.

setAttributeAccessorback to summary
public void setAttributeAccessor(ATTRIBUTE_ACCESSOR attributeAccessor)

ADVANCED: Set the attributeAccessor. The attribute accessor is responsible for setting and retrieving the attribute value from the object for this mapping. This can be set to an implementor of AttributeAccessor if the attribute requires advanced conversion of the mapping value, or a real attribute does not exist.

setAttributeNameback to summary
public void setAttributeName(String attributeName)

Sets the name of the attribute in the mapping.

setAttributeValueInObjectback to summary
public void setAttributeValueInObject(Object object, Object value)
setGetMethodNameback to summary
public void setGetMethodName(String methodName)

This method is invoked reflectively on the reference object to return the value of the attribute in the object. This method sets the name of the getMethodName.

setIsReadOnlyback to summary
public void setIsReadOnly(boolean aBoolean)

Set this mapping to be read only. Read-only mappings can be used if two attributes map to the same field. Read-only mappings cannot be used for the primary key or other required fields.

setPropertiesback to summary
public void setProperties(Map<K, V> properties)

INTERNAL: Allow user defined properties.

setSetMethodNameback to summary
public void setSetMethodName(String methodName)

Set the methodName used to set the value for the mapping's attribute into the object.

writeSingleValueback to summary
public void writeSingleValue(Object value, Object object, XML_RECORD record, ABSTRACT_SESSION session)