Top Description Constructors Methods
org.eclipse.persistence.core.mappings

public abstract Class CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, 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>

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.mappings.DatabaseMapping
Imports
java.util.Vector, org.eclipse.persistence.core.descriptors.CoreDescriptor, org.eclipse.persistence.internal.core.helper.CoreField, org.eclipse.persistence.internal.core.queries.CoreContainerPolicy, org.eclipse.persistence.internal.core.sessions.CoreAbstractSession
INTERNAL A abstraction of mapping capturing behavior common to all persistence types.

Constructor Summary

AccessConstructor and Description
protected
CoreMapping()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public abstract ATTRIBUTE_ACCESSOR

Returns:

TODO
getAttributeAccessor()

ADVANCED: Return the attributeAccessor.

public abstract Class<?>

Returns:

TODO
getAttributeClassification()

PUBLIC: The classification type for the attribute this mapping represents

public abstract String

Returns:

TODO
getAttributeName()

PUBLIC: Return the name of the attribute set in the mapping.

public abstract Object

Returns:

TODO
getAttributeValueFromObject(Object
TODO
object)

INTERNAL: Return the value of an attribute which this mapping represents for an object.

public abstract CONTAINER_POLICY

Returns:

TODO
getContainerPolicy()

INTERNAL: Return the mapping's containerPolicy.

public abstract DESCRIPTOR

Returns:

TODO
getDescriptor()

INTERNAL: Return the descriptor to which this mapping belongs

public abstract FIELD

Returns:

TODO
getField()

INTERNAL: Return the field associated with this mapping if there is exactly one.

public abstract Vector<FIELD>

Returns:

TODO
getFields()

INTERNAL: Returns a vector of all the fields this mapping represents.

public abstract DESCRIPTOR

Returns:

TODO
getReferenceDescriptor()

PUBLIC: Return the referenceDescriptor.

public abstract boolean

Returns:

TODO
isAbstractCompositeCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isAbstractCompositeDirectCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isAbstractCompositeObjectMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isAbstractDirectMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isDirectToFieldMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isReadOnly()

INTERNAL: Returns true if mapping is read only else false.

public abstract boolean

Returns:

TODO
isReferenceMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isTransformationMapping()

INTERNAL: Related mapping should implement this method to return true.

public abstract boolean

Returns:

TODO
isWriteOnly()

INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).

public abstract void
setAttributeAccessor(ATTRIBUTE_ACCESSOR
TODO
attributeAccessor)

ADVANCED: Set the attributeAccessor.

public abstract void
setAttributeName(String
TODO
attributeName)

PUBLIC: Sets the name of the attribute in the mapping.

public abstract void
setAttributeValueInObject(Object
TODO
object, Object
TODO
value)

INTERNAL: Set the value of the attribute mapped by this mapping.

public abstract void
setDescriptor(DESCRIPTOR
TODO
descriptor)

INTERNAL: Set the descriptor to which this mapping belongs

protected abstract void
setFields(Vector<FIELD>
TODO
fields)

INTERNAL: Set the mapping's field collection.

public abstract Object

Returns:

TODO
valueFromObject(Object
TODO
anObject, FIELD
TODO
field, ABSTRACT_SESSION
TODO
session)

INTERNAL: A subclass should extract the value from the object for the field, if it does not map the field then it should return null.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

CoreMappingback to summary
protected CoreMapping()

Default constructor.

Method Detail

getAttributeAccessorback to summary
public abstract ATTRIBUTE_ACCESSOR getAttributeAccessor()

ADVANCED: Return the attributeAccessor. The attribute accessor is responsible for setting and retrieving the attribute value from the object for this mapping.

Returns:ATTRIBUTE_ACCESSOR

TODO

getAttributeClassificationback to summary
public abstract Class<?> getAttributeClassification()

PUBLIC: The classification type for the attribute this mapping represents

Returns:Class<?>

TODO

getAttributeNameback to summary
public abstract String getAttributeName()

PUBLIC: Return the name of the attribute set in the mapping.

Returns:String

TODO

getAttributeValueFromObjectback to summary
public abstract Object getAttributeValueFromObject(Object object)

INTERNAL: Return the value of an attribute which this mapping represents for an object.

Parameters
object:Object

TODO

Returns:Object

TODO

getContainerPolicyback to summary
public abstract CONTAINER_POLICY getContainerPolicy()

INTERNAL: Return the mapping's containerPolicy.

Returns:CONTAINER_POLICY

TODO

getDescriptorback to summary
public abstract DESCRIPTOR getDescriptor()

INTERNAL: Return the descriptor to which this mapping belongs

Returns:DESCRIPTOR

TODO

getFieldback to summary
public abstract FIELD getField()

INTERNAL: Return the field associated with this mapping if there is exactly one. This is required for object relational mapping to print them, but because they are defined in in an Enterprise context they cannot be cast to. Mappings that have a field include direct mappings and object relational mappings.

Returns:FIELD

TODO

getFieldsback to summary
public abstract Vector<FIELD> getFields()

INTERNAL: Returns a vector of all the fields this mapping represents.

Returns:Vector<FIELD>

TODO

getReferenceDescriptorback to summary
public abstract DESCRIPTOR getReferenceDescriptor()

PUBLIC: Return the referenceDescriptor. This is a descriptor which is associated with the reference class.

Returns:DESCRIPTOR

TODO

isAbstractCompositeCollectionMappingback to summary
public abstract boolean isAbstractCompositeCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isAbstractCompositeDirectCollectionMappingback to summary
public abstract boolean isAbstractCompositeDirectCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isAbstractCompositeObjectMappingback to summary
public abstract boolean isAbstractCompositeObjectMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isAbstractDirectMappingback to summary
public abstract boolean isAbstractDirectMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isCollectionMappingback to summary
public abstract boolean isCollectionMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isDirectToFieldMappingback to summary
public abstract boolean isDirectToFieldMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isReadOnlyback to summary
public abstract boolean isReadOnly()

INTERNAL: Returns true if mapping is read only else false.

Returns:boolean

TODO

isReferenceMappingback to summary
public abstract boolean isReferenceMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isTransformationMappingback to summary
public abstract boolean isTransformationMapping()

INTERNAL: Related mapping should implement this method to return true.

Returns:boolean

TODO

isWriteOnlyback to summary
public abstract boolean isWriteOnly()

INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).

Returns:boolean

TODO

setAttributeAccessorback to summary
public abstract 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.

Parameters
attributeAccessor:ATTRIBUTE_ACCESSOR

TODO

setAttributeNameback to summary
public abstract void setAttributeName(String attributeName)

PUBLIC: Sets the name of the attribute in the mapping.

Parameters
attributeName:String

TODO

setAttributeValueInObjectback to summary
public abstract void setAttributeValueInObject(Object object, Object value)

INTERNAL: Set the value of the attribute mapped by this mapping.

Parameters
object:Object

TODO

value:Object

TODO

setDescriptorback to summary
public abstract void setDescriptor(DESCRIPTOR descriptor)

INTERNAL: Set the descriptor to which this mapping belongs

Parameters
descriptor:DESCRIPTOR

TODO

setFieldsback to summary
protected abstract void setFields(Vector<FIELD> fields)

INTERNAL: Set the mapping's field collection.

Parameters
fields:Vector<FIELD>

TODO

valueFromObjectback to summary
public abstract Object valueFromObject(Object anObject, FIELD field, ABSTRACT_SESSION session)

INTERNAL: A subclass should extract the value from the object for the field, if it does not map the field then it should return null. Return the Value from the object.

Parameters
anObject:Object

TODO

field:FIELD

TODO

session:ABSTRACT_SESSION

TODO

Returns:Object

TODO