Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.mappings

Class XMLChoiceCollectionMapping

java.lang.Object

org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,AbstractSession,ContainerPolicy,ClassDescriptor,DatabaseField>

org.eclipse.persistence.mappings.DatabaseMapping

org.eclipse.persistence.oxm.mappings.XMLChoiceCollectionMapping

All Implemented Interfaces:

Serializable, Cloneable, ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>, Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>, XMLContainerMapping, XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>, XMLMapping

public class XMLChoiceCollectionMapping
extends DatabaseMapping
implements ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>, XMLMapping

PUBLIC:

Purpose:Provide a mapping that can map a single attribute to a number of different elements in an XML Document. This will be used to map to Choices or Substitution Groups in an XML Schema

Responsibilities:

• Allow the user to specify XPath -> Type mappings
• Handle reading and writing of XML Documents containing a collection of choice or substitution group elements

The XMLChoiceCollectionMapping is the collection version of the XMLChoiceMapping. This mapping allows the user to specify a number of different xpaths, and types associated with those xpaths. When any of these elements are encountered in the XML Document, they are read in as the correct type and added to the collection.

Setting up XPath mappings:Unlike other OXM Mappings, instead of setting a single xpath, the addChoiceElement method is used to specify an xpath and the type associated with this xpath.
xmlChoiceCollectionMapping.addChoiceElement("mystring/text()", String.class);
xmlChoiceCollectionMapping.addChoiceElement("myaddress", Address.class);

See Also:

• Serialized Form

Nested Class Summary

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

DatabaseMapping.WriteType

Field Summary

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

Fields inherited from interface org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping

EMPTY_CONTAINER_DEFAULT

Constructor Summary

Constructors

Constructor	Description
XMLChoiceCollectionMapping()

Method Summary

Modifier and Type	Method	Description
void	addChoiceElement(String xpath, Class<?> elementType)
void	addChoiceElement(String srcXPath, Class<?> elementType, String tgtXPath)
void	addChoiceElement(String xpath, String elementTypeName)
void	addChoiceElement(String srcXpath, String elementTypeName, String tgtXpath)
void	addChoiceElement(List<XMLField> srcFields, Class<?> elementType, List<XMLField> tgtFields)
void	addChoiceElement(List<XMLField> srcFields, String elementTypeName, List<XMLField> tgtFields)
void	addChoiceElement(XMLField xmlField, Class<?> elementType)
void	addChoiceElement(XMLField sourceField, Class<?> elementType, XMLField targetField)
void	addChoiceElement(XMLField field, String elementTypeName)
void	addConverter(XMLField field, Converter converter)
void	buildBackupClone(Object clone, Object backup, UnitOfWorkImpl unitOfWork)	INTERNAL: Clone the attribute from the clone and assign it to the backup.
void	buildClone(Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession)	INTERNAL: Clone the attribute from the original and assign it to the clone.
void	buildCloneFromRow(AbstractRecord databaseRow, JoinedAttributeManager joinManager, Object clone, CacheKey sharedCacheKey, ObjectBuildingQuery sourceQuery, UnitOfWorkImpl unitOfWork, AbstractSession executionSession)	INTERNAL: A combination of readFromRowIntoObject and buildClone.
void	cascadePerformRemoveIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects)	INTERNAL: Cascade perform delete through mappings that require the cascade
void	cascadeRegisterNewIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects)	INTERNAL: Cascade registerNew for Create through mappings that require the cascade
protected Vector<DatabaseField>	collectFields()	This method must be overwritten in the subclasses to return a vector of all the fields this mapping represents.
ChangeRecord	compareForChange(Object clone, Object backup, ObjectChangeSet owner, AbstractSession session)	INTERNAL: This method was created in VisualAge.
boolean	compareObjects(Object firstObject, Object secondObject, AbstractSession session)	INTERNAL: Compare the attributes belonging to this mapping for the objects.
void	convertClassNamesToClasses(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.
Object	convertDataValueToObjectValue(Object fieldValue, Session session, XMLUnmarshaller unmarshaller)	INTERNAL
Object	convertObjectValueToDataValue(Object value, Session session, XMLMarshaller marshaller)	INTERNAL
void	fixObjectReferences(Object object, Map<Object,ObjectDescriptor> objectDescriptors, Map<Object,Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session)	INTERNAL: An object has been serialized from the server to the client.
XMLAnyCollectionMapping	getAnyMapping()
Map<XMLField,XMLMapping>	getChoiceElementMappings()
Map<Class<?>,XMLMapping>	getChoiceElementMappingsByClass()
ArrayList	getChoiceFieldToClassAssociations()
Map<String,XMLField>	getClassNameToFieldMappings()
Map<Class<?>,XMLField>	getClassToFieldMappings()
Map<Class<?>,List<XMLField>>	getClassToSourceFieldsMappings()
ContainerPolicy	getContainerPolicy()	INTERNAL: Return the mapping's containerPolicy.
Converter	getConverter()	Return the converter on the mapping.
Converter	getConverter(XMLField field)
Vector<DatabaseField>	getFields()	INTERNAL: Returns a vector of all the fields this mapping represents.
Map<XMLField,Class<?>>	getFieldToClassMappings()
XMLCompositeDirectCollectionMapping	getMixedContentMapping()
boolean	getReuseContainer()	Return true if the original container on the object should be used if present.
AbstractNullPolicy	getWrapperNullPolicy()	Get the Wrapper NullPolicy from the Mapping.
void	initialize(AbstractSession session)	INTERNAL: Allow for initialization of properties and validation.
boolean	isAny()
boolean	isDefaultEmptyContainer()	INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.
boolean	isMixedContent()
boolean	isWriteOnly()	INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).
boolean	isXMLMapping()	INTERNAL: All relational mappings should implement this method to return true.
void	iterate(DescriptorIterator iterator)	INTERNAL: Iterate on the appropriate attribute value.
void	mergeChangesIntoObject(Object target, ChangeRecord changeRecord, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Merge changes from the source to the target object.
void	mergeIntoObject(Object target, boolean isTargetUninitialized, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Merge changes from the source to the target object.
void	preInitialize(AbstractSession session)	INTERNAL: Allow for initialization of properties and validation.
void	setAttributeValueInObject(Object object, Object value)	INTERNAL: Set the value of the attribute mapped by this mapping.
void	setChoiceElementMappingsByClass(Map<Class<?>,XMLMapping> choiceElementMappingsByClass)
void	setChoiceFieldToClassAssociations(ArrayList associations)
void	setContainerPolicy(ContainerPolicy cp)
void	setConverter(Converter converter)	Set the converter on the mapping.
void	setDefaultEmptyContainer(boolean defaultEmptyContainer)	INTERNAL Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.
void	setIsAny(boolean b)
void	setIsWriteOnly(boolean b)
void	setMixedContent(boolean mixed)	PUBLIC: Allows the user to indicate that this mapping should also allow for mixed content in addition to any of the elements in the choice.
void	setMixedContent(String groupingElement)	PUBLIC: Allows the user to indicate that this mapping should also allow for mixed content in addition to any of the elements in the choice.
void	setReuseContainer(boolean reuseContainer)	Specify whether the original container on the object should be used if present.
void	setWrapperNullPolicy(AbstractNullPolicy policy)	Set the Wrapper NullPolicy on the Mapping.
void	useCollectionClass(Class<?> concreteContainerClass)
void	useCollectionClassName(String concreteContainerClassName)
Object	valueFromRow(AbstractRecord row, JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, CacheKey cacheKey, AbstractSession executionSession, boolean isTargetProtected, Boolean[] wasCacheUsed)	INTERNAL: A subclass should implement this method if it wants different behavior.
void	writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL: A subclass should implement this method if it wants different behavior.
void	writeSingleValue(Object value, Object parent, XMLRecord row, AbstractSession session)	INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath.

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

addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildCopy, buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectQueryParameters, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getField, getFieldClassification, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getReferenceDescriptor, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasNestedIdentityReference, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, 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, iterateOnRealAttributeValue, load, loadAll, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInitializeSourceAndTargetExpressions, postInsert, postUpdate, preDelete, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remoteInitialization, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, updateChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, verifyDelete, writeFromAttributeIntoRow, 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

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Mapping

getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDescriptor, getField, getReferenceDescriptor, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setGetMethodName, setIsReadOnly, setProperties, setSetMethodName

Constructor Details

XMLChoiceCollectionMapping

public XMLChoiceCollectionMapping()

Method Details

getConverter

public Converter getConverter()

Return the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

Specified by:

getConverter in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

setConverter

public void setConverter(Converter converter)

Set the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

Specified by:

setConverter in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

buildBackupClone

public void buildBackupClone(Object clone,
 Object backup,
 UnitOfWorkImpl unitOfWork)

INTERNAL: Clone the attribute from the clone and assign it to the backup.

Specified by:

buildBackupClone in class DatabaseMapping

Parameters:

clone - TODO

backup - TODO

unitOfWork - TODO

buildClone

public void buildClone(Object original,
 CacheKey cacheKey,
 Object clone,
 Integer refreshCascade,
 AbstractSession cloningSession)

INTERNAL: Clone the attribute from the original and assign it to the clone.

Specified by:

buildClone in class DatabaseMapping

Parameters:

original - TODO

cacheKey - TODO

clone - TODO

refreshCascade - TODO

cloningSession - TODO

buildCloneFromRow

public void buildCloneFromRow(AbstractRecord databaseRow,
 JoinedAttributeManager joinManager,
 Object clone,
 CacheKey sharedCacheKey,
 ObjectBuildingQuery sourceQuery,
 UnitOfWorkImpl unitOfWork,
 AbstractSession executionSession)

Description copied from class: DatabaseMapping

INTERNAL: A combination of readFromRowIntoObject and buildClone.

buildClone assumes the attribute value exists on the original and can simply be copied.

readFromRowIntoObject assumes that one is building an original.

Both of the above assumptions are false in this method, and actually attempts to do both at the same time.

Extract value from the row and set the attribute to this value in the working copy clone. In order to bypass the shared cache when in transaction a UnitOfWork must be able to populate working copies directly from the row.

Specified by:

buildCloneFromRow in class DatabaseMapping

Parameters:

databaseRow - TODO

joinManager - TODO

clone - TODO

sharedCacheKey - TODO

sourceQuery - TODO

unitOfWork - TODO

executionSession - TODO

cascadePerformRemoveIfRequired

public void cascadePerformRemoveIfRequired(Object object,
 UnitOfWorkImpl uow,
 Map visitedObjects)

INTERNAL: Cascade perform delete through mappings that require the cascade

Specified by:

cascadePerformRemoveIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

cascadeRegisterNewIfRequired

public void cascadeRegisterNewIfRequired(Object object,
 UnitOfWorkImpl uow,
 Map visitedObjects)

INTERNAL: Cascade registerNew for Create through mappings that require the cascade

Specified by:

cascadeRegisterNewIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

compareForChange

public ChangeRecord compareForChange(Object clone,
 Object backup,
 ObjectChangeSet owner,
 AbstractSession session)

INTERNAL: This method was created in VisualAge.

Specified by:

compareForChange in class DatabaseMapping

Parameters:

clone - TODO

backup - TODO

owner - TODO

session - TODO

Returns:

prototype.changeset.ChangeRecord

compareObjects

public boolean compareObjects(Object firstObject,
 Object secondObject,
 AbstractSession session)

INTERNAL: Compare the attributes belonging to this mapping for the objects.

Specified by:

compareObjects in class DatabaseMapping

Parameters:

firstObject - TODO

secondObject - TODO

session - TODO

Returns:

TODO

fixObjectReferences

public void fixObjectReferences(Object object,
 Map<Object,ObjectDescriptor> objectDescriptors,
 Map<Object,Object> 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

Parameters:

object - TODO

objectDescriptors - TODO

processedObjects - TODO

query - TODO

session - TODO

iterate

public void iterate(DescriptorIterator iterator)

INTERNAL: Iterate on the appropriate attribute value.

Specified by:

iterate in class DatabaseMapping

mergeChangesIntoObject

public void mergeChangesIntoObject(Object target,
 ChangeRecord changeRecord,
 Object source,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: Merge changes from the source to the target object.

Specified by:

mergeChangesIntoObject in class DatabaseMapping

mergeIntoObject

public void mergeIntoObject(Object target,
 boolean isTargetUninitialized,
 Object source,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: Merge changes from the source to the target object.

Specified by:

mergeIntoObject in class DatabaseMapping

valueFromRow

public Object valueFromRow(AbstractRecord row,
 JoinedAttributeManager joinManager,
 ObjectBuildingQuery sourceQuery,
 CacheKey cacheKey,
 AbstractSession executionSession,
 boolean isTargetProtected,
 Boolean[] wasCacheUsed)
                    throws DatabaseException

Description copied from class: DatabaseMapping

INTERNAL: A subclass should implement this method if it wants different behavior. Returns the value for the mapping from the database row. The execution session is the session the query was executed on, and its platform should be used for data conversion.

Overrides:

valueFromRow in class DatabaseMapping

Throws:

DatabaseException

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
 AbstractRecord row,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)
                            throws DescriptorException

Description copied from class: DatabaseMapping

INTERNAL: A subclass should implement this method if it wants different behavior. Write the attribute value from the object to the row.

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

Throws:

DescriptorException

writeSingleValue

public void writeSingleValue(Object value,
 Object parent,
 XMLRecord row,
 AbstractSession session)

Description copied from interface: XMLMapping

INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath. Used for Sequenced marshalling.

Specified by:

writeSingleValue in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>

Specified by:

writeSingleValue in interface XMLMapping

Parameters:

value - - The value to be marshalled

row - - The Record the value is being marshalled too.

isXMLMapping

public boolean isXMLMapping()

Description copied from class: DatabaseMapping

INTERNAL: All relational mappings should implement this method to return true.

Overrides:

isXMLMapping in class DatabaseMapping

getFields

public Vector<DatabaseField> getFields()

Description copied from class: DatabaseMapping

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

Overrides:

getFields in class DatabaseMapping

Returns:

TODO

collectFields

protected Vector<DatabaseField> collectFields()

Description copied from class: DatabaseMapping

This method must be overwritten in the subclasses to return a vector of all the fields this mapping represents.

Overrides:

collectFields in class DatabaseMapping

Returns:

TODO

addChoiceElement

public void addChoiceElement(String xpath,
 Class<?> elementType)

addChoiceElement

public void addChoiceElement(String xpath,
 String elementTypeName)

Specified by:

addChoiceElement in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

addChoiceElement

public void addChoiceElement(XMLField xmlField,
 Class<?> elementType)

addChoiceElement

public void addChoiceElement(List<XMLField> srcFields,
 Class<?> elementType,
 List<XMLField> tgtFields)

addChoiceElement

public void addChoiceElement(List<XMLField> srcFields,
 String elementTypeName,
 List<XMLField> tgtFields)

Specified by:

addChoiceElement in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

addChoiceElement

public void addChoiceElement(String srcXPath,
 Class<?> elementType,
 String tgtXPath)

addChoiceElement

public void addChoiceElement(String srcXpath,
 String elementTypeName,
 String tgtXpath)

Specified by:

addChoiceElement in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

addChoiceElement

public void addChoiceElement(XMLField sourceField,
 Class<?> elementType,
 XMLField targetField)

addChoiceElement

public void addChoiceElement(XMLField field,
 String elementTypeName)

Specified by:

addChoiceElement in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getFieldToClassMappings

public Map<XMLField,Class<?>> getFieldToClassMappings()

Specified by:

getFieldToClassMappings in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

Description copied from class: DatabaseMapping

INTERNAL: Allow for initialization of properties and validation.

Overrides:

initialize in class DatabaseMapping

Throws:

DescriptorException

getClassToFieldMappings

public Map<Class<?>,XMLField> getClassToFieldMappings()

Specified by:

getClassToFieldMappings in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getChoiceElementMappings

public Map<XMLField,XMLMapping> getChoiceElementMappings()

Specified by:

getChoiceElementMappings in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getContainerPolicy

public ContainerPolicy getContainerPolicy()

Description copied from class: DatabaseMapping

INTERNAL: Return the mapping's containerPolicy.

Specified by:

getContainerPolicy in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>

Overrides:

getContainerPolicy in class DatabaseMapping

Returns:

TODO

setContainerPolicy

public void setContainerPolicy(ContainerPolicy cp)

useCollectionClass

public void useCollectionClass(Class<?> concreteContainerClass)

useCollectionClassName

public void useCollectionClassName(String concreteContainerClassName)

Specified by:

useCollectionClassName in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

convertClassNamesToClasses

public void convertClassNamesToClasses(ClassLoader classLoader)

Description copied from class: DatabaseMapping

INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.

Specified by:

convertClassNamesToClasses in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>

Specified by:

convertClassNamesToClasses in interface XMLMapping

Overrides:

convertClassNamesToClasses in class DatabaseMapping

Parameters:

classLoader - TODO

addConverter

public void addConverter(XMLField field,
 Converter converter)

Specified by:

addConverter in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getConverter

public Converter getConverter(XMLField field)

Specified by:

getConverter in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getChoiceFieldToClassAssociations

public ArrayList getChoiceFieldToClassAssociations()

Specified by:

getChoiceFieldToClassAssociations in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

setChoiceFieldToClassAssociations

public void setChoiceFieldToClassAssociations(ArrayList associations)

isWriteOnly

public boolean isWriteOnly()

Description copied from class: DatabaseMapping

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

Specified by:

isWriteOnly in interface XMLMapping

Overrides:

isWriteOnly in class DatabaseMapping

Returns:

TODO

setIsWriteOnly

public void setIsWriteOnly(boolean b)

Specified by:

setIsWriteOnly in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

Specified by:

setIsWriteOnly in interface XMLMapping

isAny

public boolean isAny()

Specified by:

isAny in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

setIsAny

public void setIsAny(boolean b)

preInitialize

public void preInitialize(AbstractSession session)
                   throws DescriptorException

Description copied from class: DatabaseMapping

INTERNAL: Allow for initialization of properties and validation.

Overrides:

preInitialize in class DatabaseMapping

Throws:

DescriptorException

setAttributeValueInObject

public void setAttributeValueInObject(Object object,
 Object value)
                               throws DescriptorException

Description copied from class: DatabaseMapping

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

Specified by:

setAttributeValueInObject in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>

Overrides:

setAttributeValueInObject in class DatabaseMapping

Parameters:

object - TODO

value - TODO

Throws:

DescriptorException

getReuseContainer

public boolean getReuseContainer()

Return true if the original container on the object should be used if present. If it is not present then the container policy will be used to create the container.

Specified by:

getReuseContainer in interface XMLContainerMapping

setReuseContainer

public void setReuseContainer(boolean reuseContainer)

Specify whether the original container on the object should be used if present. If it is not present then the container policy will be used to create the container.

Specified by:

setReuseContainer in interface XMLContainerMapping

getClassToSourceFieldsMappings

public Map<Class<?>,List<XMLField>> getClassToSourceFieldsMappings()

Specified by:

getClassToSourceFieldsMappings in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getClassNameToFieldMappings

public Map<String,XMLField> getClassNameToFieldMappings()

Specified by:

getClassNameToFieldMappings in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

isMixedContent

public boolean isMixedContent()

Specified by:

isMixedContent in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

setMixedContent

public void setMixedContent(String groupingElement)

PUBLIC: Allows the user to indicate that this mapping should also allow for mixed content in addition to any of the elements in the choice. The grouping element parameter is used in the case that there is a common grouping element to all the other elements in this choice. If so, that grouping element can be specified here to allow the mixed content to be written/detected inside the wrapper element.

Specified by:

setMixedContent in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

Since:

EclipseLink 2.3.1

setMixedContent

public void setMixedContent(boolean mixed)

PUBLIC: Allows the user to indicate that this mapping should also allow for mixed content in addition to any of the elements in the choice.

Specified by:

setMixedContent in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

Since:

EclipseLink 2.3.1

getMixedContentMapping

public XMLCompositeDirectCollectionMapping getMixedContentMapping()

Specified by:

getMixedContentMapping in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

getAnyMapping

public XMLAnyCollectionMapping getAnyMapping()

Specified by:

getAnyMapping in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

isDefaultEmptyContainer

public boolean isDefaultEmptyContainer()

INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.

Specified by:

isDefaultEmptyContainer in interface XMLContainerMapping

Since:

EclipseLink 2.3.3

setDefaultEmptyContainer

public void setDefaultEmptyContainer(boolean defaultEmptyContainer)

INTERNAL Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.

Specified by:

setDefaultEmptyContainer in interface XMLContainerMapping

Since:

EclipseLink 2.3.3

getWrapperNullPolicy

public AbstractNullPolicy getWrapperNullPolicy()

Description copied from interface: XMLContainerMapping

Get the Wrapper NullPolicy from the Mapping.

Specified by:

getWrapperNullPolicy in interface XMLContainerMapping

setWrapperNullPolicy

public void setWrapperNullPolicy(AbstractNullPolicy policy)

Description copied from interface: XMLContainerMapping

Set the Wrapper NullPolicy on the Mapping.

Specified by:

setWrapperNullPolicy in interface XMLContainerMapping

getChoiceElementMappingsByClass

public Map<Class<?>,XMLMapping> getChoiceElementMappingsByClass()

Specified by:

getChoiceElementMappingsByClass in interface ChoiceCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLField,XMLMapping,XMLRecord>

setChoiceElementMappingsByClass

public void setChoiceElementMappingsByClass(Map<Class<?>,XMLMapping> choiceElementMappingsByClass)

convertObjectValueToDataValue

public Object convertObjectValueToDataValue(Object value,
 Session session,
 XMLMarshaller marshaller)

INTERNAL

Specified by:

convertObjectValueToDataValue in interface XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>

Since:

EclipseLink 2.5.0

convertDataValueToObjectValue

public Object convertDataValueToObjectValue(Object fieldValue,
 Session session,
 XMLUnmarshaller unmarshaller)

INTERNAL

Specified by:

convertDataValueToObjectValue in interface XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>

Since:

EclipseLink 2.5.0