AbstractColumnMapping (EclipseLink 2.6.5, API Reference)

java.lang.Object
- org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField>
- - org.eclipse.persistence.mappings.DatabaseMapping
  - - org.eclipse.persistence.mappings.foundation.AbstractColumnMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractDirectMapping, MultitenantPrimaryKeyMapping
```
public abstract class AbstractColumnMapping
extends DatabaseMapping
```
Purpose: Maps an attribute or some other property to the corresponding database field type. The list of field types that are supported by EclipseLink's direct to field mapping is dependent on the relational database being used.

See Also:
AbstractDirectMapping, MultitenantPrimaryKeyMapping, Serialized Form
Author:

Guy Pelletier

Since:

TopLink/Java 1.0

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping
  DatabaseMapping.WriteType

Field Summary

Fields
Modifier and Type	Field and Description
`protected Converter`	`converter` Allows user defined conversion between the object attribute value and the database value.
`protected java.lang.String`	`converterClassName`
`protected org.eclipse.persistence.internal.helper.DatabaseField`	`field` DatabaseField which this mapping represents.
`protected boolean`	`isInsertable` Flag to support insertable JPA setting
`protected boolean`	`isUpdatable` Flag to support updatable JPA setting

Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping
attributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isInSopObject, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, unconvertedProperties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM

Constructor Summary

Constructors
Constructor and Description

AbstractColumnMapping()
Default constructor.

Constructors
Constructor and Description
`AbstractColumnMapping()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cascadePerformRemoveIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade perform delete through mappings that require the cascade.
`void`	`cascadeRegisterNewIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade registerNew for Create through mappings that require the cascade.
`java.lang.Object`	`clone()` INTERNAL: The mapping clones itself to create deep copy.
`protected java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>`	`collectFields()` Returns the field this mapping represents.
`void`	`convertClassNamesToClasses(java.lang.ClassLoader classLoader)` INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.
`void`	`fixObjectReferences(java.lang.Object object, java.util.Map objectDescriptors, java.util.Map processedObjects, ObjectLevelReadQuery query, DistributedSession session)` INTERNAL: An object has been serialized from the server to the client.
`Converter`	`getConverter()` PUBLIC: Return the converter on the mapping.
`org.eclipse.persistence.internal.helper.DatabaseField`	`getField()` INTERNAL: Returns the field which this mapping represents.
`abstract java.lang.Object`	`getFieldValue(java.lang.Object objectValue, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Convert the object (attribute or property) value to a field value.
`abstract java.lang.Object`	`getObjectValue(java.lang.Object fieldValue, Session session)` INTERNAL: Allows for subclasses to convert the the attribute or property value.
`boolean`	`hasConverter()` Indicates if the mapping has a converter set on it.
`boolean`	`isAbstractColumnMapping()` INTERNAL:
`protected boolean`	`isInsertable()` INTERNAL: Return true if this mapping is insertable.
`protected boolean`	`isUpdatable()` INTERNAL: Return true if this mapping is updatable.
`void`	`iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)` INTERNAL: Iterate on the appropriate attribute.
`void`	`setConverter(Converter converter)` PUBLIC: Set the converter on the mapping.
`void`	`setConverterClassName(java.lang.String converterClassName)` PUBLIC: Set the converter class name on the mapping.
`void`	`setField(org.eclipse.persistence.internal.helper.DatabaseField theField)` ADVANCED: Set the field in the mapping.
`java.lang.String`	`toString()` INTERNAL:
`protected abstract void`	`writeValueIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.helper.DatabaseField field, java.lang.Object value)` INTERNAL:

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping
addUnconvertedProperty, buildBackupClone, buildBackupCloneForPartObject, buildChangeRecord, buildClone, buildCloneForPartObject, buildCloneFromRow, buildContainerClone, buildCopy, buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cloneFields, collectQueryParameters, compareForChange, compareObjects, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getReferenceDescriptor, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasNestedIdentityReference, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, initialize, instantiateAttribute, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, load, loadAll, mergeChangesIntoObject, mergeIntoObject, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInitializeSourceAndTargetExpressions, postInsert, postUpdate, preDelete, preInitialize, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remoteInitialization, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, updateChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - field
```
protected org.eclipse.persistence.internal.helper.DatabaseField field
```
    DatabaseField which this mapping represents.
  - converter
```
protected Converter converter
```
    Allows user defined conversion between the object attribute value and the database value.
  - converterClassName
```
protected java.lang.String converterClassName
```
  - isInsertable
```
protected boolean isInsertable
```
    Flag to support insertable JPA setting
  - isUpdatable
```
protected boolean isUpdatable
```
    Flag to support updatable JPA setting
- Constructor Detail
  - AbstractColumnMapping
```
public AbstractColumnMapping()
```
    Default constructor.
- Method Detail
  - cascadePerformRemoveIfRequired
```
public void cascadePerformRemoveIfRequired(java.lang.Object object,
                                  org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                  java.util.Map visitedObjects)
```
    INTERNAL: Cascade perform delete through mappings that require the cascade.
    
    Specified by:
    
    cascadePerformRemoveIfRequired in class DatabaseMapping
  - cascadeRegisterNewIfRequired
```
public void cascadeRegisterNewIfRequired(java.lang.Object object,
                                org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                java.util.Map visitedObjects)
```
    INTERNAL: Cascade registerNew for Create through mappings that require the cascade.
    
    Specified by:
    
    cascadeRegisterNewIfRequired in class DatabaseMapping
  - clone
```
public java.lang.Object clone()
```
    INTERNAL: The mapping clones itself to create deep copy.
    
    Overrides:
    
    clone in class DatabaseMapping
  - collectFields
```
protected java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> collectFields()
```
    Returns the field this mapping represents.
    
    Overrides:
    
    collectFields in class DatabaseMapping
  - convertClassNamesToClasses
```
public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
```
    INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.
    
    Overrides:
    
    convertClassNamesToClasses in class DatabaseMapping
  - fixObjectReferences
```
public void fixObjectReferences(java.lang.Object object,
                       java.util.Map objectDescriptors,
                       java.util.Map processedObjects,
                       ObjectLevelReadQuery query,
                       DistributedSession session)
```
    INTERNAL: An object has been serialized from the server to the client. Replace the transient attributes of the remote value holders with client-side objects.
    
    Specified by:
    
    fixObjectReferences in class DatabaseMapping
  - getConverter
```
public Converter getConverter()
```
    PUBLIC: Return the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.
  - getField
```
public org.eclipse.persistence.internal.helper.DatabaseField getField()
```
    INTERNAL: Returns the field which this mapping represents.
    
    Overrides:
    
    getField in class DatabaseMapping
  - getFieldValue
```
public abstract java.lang.Object getFieldValue(java.lang.Object objectValue,
                             org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    INTERNAL: Convert the object (attribute or property) value to a field value.
  - getObjectValue
```
public abstract java.lang.Object getObjectValue(java.lang.Object fieldValue,
                              Session session)
```
    INTERNAL: Allows for subclasses to convert the the attribute or property value.
  - hasConverter
```
public boolean hasConverter()
```
    Indicates if the mapping has a converter set on it.
    
    Returns:
    true if there is a converter set on the mapping, false otherwise.
  - isAbstractColumnMapping
```
public boolean isAbstractColumnMapping()
```
    INTERNAL:
    
    Overrides:
    
    isAbstractColumnMapping in class DatabaseMapping
  - isInsertable
```
protected boolean isInsertable()
```
    INTERNAL: Return true if this mapping is insertable.
  - isUpdatable
```
protected boolean isUpdatable()
```
    INTERNAL: Return true if this mapping is updatable.
  - iterate
```
public void iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)
```
    INTERNAL: Iterate on the appropriate attribute.
    
    Specified by:
    
    iterate in class DatabaseMapping
  - setConverter
```
public void setConverter(Converter converter)
```
    PUBLIC: Set the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.
  - setConverterClassName
```
public void setConverterClassName(java.lang.String converterClassName)
```
    PUBLIC: Set the converter class name on the mapping. It will be instantiated during the convertClassNamesToClasses. A converter can be used to convert between the object's value and database value of the attribute.
  - setField
```
public void setField(org.eclipse.persistence.internal.helper.DatabaseField theField)
```
    ADVANCED: Set the field in the mapping. This can be used for advanced field types, such as XML nodes, or to set the field type.
  - toString
```
public java.lang.String toString()
```
    INTERNAL:
    
    Overrides:
    
    toString in class DatabaseMapping
  - writeValueIntoRow
```
protected abstract void writeValueIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                     org.eclipse.persistence.internal.helper.DatabaseField field,
                     java.lang.Object value)
```
    INTERNAL:

Class AbstractColumnMapping

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping

Field Summary

Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping

Methods inherited from class java.lang.Object

Field Detail

field

converter

converterClassName

isInsertable

isUpdatable

Constructor Detail

AbstractColumnMapping

Method Detail

cascadePerformRemoveIfRequired

cascadeRegisterNewIfRequired

clone

collectFields

convertClassNamesToClasses

fixObjectReferences

getConverter

getField

getFieldValue

getObjectValue

hasConverter

isAbstractColumnMapping

isInsertable

isUpdatable

iterate

setConverter

setConverterClassName

setField

toString

writeValueIntoRow