Package org.eclipse.persistence.oxm.mappings

Class XMLBinaryDataCollectionMapping

java.lang.Object

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

org.eclipse.persistence.mappings.DatabaseMapping

org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

org.eclipse.persistence.oxm.mappings.XMLCompositeDirectCollectionMapping

org.eclipse.persistence.oxm.mappings.XMLBinaryDataCollectionMapping

All Implemented Interfaces:

Serializable, Cloneable, BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>, DirectCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>, XMLContainerMapping, XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>, ContainerMapping, ArrayCollectionMapping, XMLMapping, XMLNillableMapping

public class XMLBinaryDataCollectionMapping
extends XMLCompositeDirectCollectionMapping
implements BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

Purpose:Provide a mapping for a collection of binary data values that can be treated as either inline binary values or as an attachment.

Responsibilities:

• Handle converting binary types (byte[], Image etc) to base64
• Make callbacks to AttachmentMarshaller/AttachmentUnmarshaller
• Write out approriate attachment information (xop:include)

XMLBinaryDataCollectionMapping represents a mapping of a collection of binary data in the object model to XML. This can either be written directly as inline binary data (base64) or passed through as an MTOM or SWAREF attachment.

The following types are allowable to be mapped using an XMLBinaryDataMapping:

• java.awt.Image
• byte[]
• jakarta.activation.DataHandler
• javax.xml.transform.Source
• jakarta.mail.internet.MimeMultipart

Setting the XPath: TopLink XML mappings make use of XPath statements to find the relevant data in an XML document. The XPath statement is relative to the context node specified in the descriptor. The XPath may contain path and positional information; the last node in the XPath forms the local node for the binary mapping. The XPath is specified on the mapping using the setXPath method.

Inline Binary Data: Set this flag if you want to always inline binary data for this mapping. This will disable consideration for attachment handling for this mapping.

SwaRef: Set this flag in order to specify that the target node of this mapping is of type xs:swaref

Since:

TopLink 11.1.1.0.0g

See Also:

XMLAttachmentMarshaller, XMLAttachmentUnmarshaller, MimeTypePolicy, 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.oxm.mappings.XMLCompositeDirectCollectionMapping

nullValue, reuseContainer

Fields inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

elementDataTypeName, field, valueConverter

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
XMLBinaryDataCollectionMapping()

Method Summary

Modifier and Type	Method	Description
Class	getAttributeElementClass()	PUBLIC: Return the class each element in the object's collection should be converted to, before the collection is inserted into the object.
Class	getCollectionContentType()
String	getMimeType()	INTERNAL
String	getMimeType(Object anObject)	INTERNAL
MimeTypePolicy	getMimeTypePolicy()
Object	getValueToWrite(Object value, Object parent, XMLRecord record, XMLField field, XMLField includeField, AbstractSession session)
boolean	isAbstractCompositeDirectCollectionMapping()	INTERNAL:
boolean	isSwaRef()
void	setAttributeElementClass(Class attributeElementClass)	PUBLIC: Set the class each element in the object's collection should be converted to, before the collection is inserted into the object.
void	setCollectionContentType(Class javaClass)
void	setMimeType(String mimeTypeString)	Force mapping to set default FixedMimeTypePolicy using the MimeType string as argument
void	setMimeTypePolicy(MimeTypePolicy mimeTypePolicy)	Allow implementer to set the MimeTypePolicy class FixedMimeTypePolicy or AttributeMimeTypePolicy (dynamic)
void	setShouldInlineBinaryData(boolean b)
void	setSwaRef(boolean swaRef)
void	setXPath(String xpathString)	Set the Mapping field name attribute to the given XPath String
boolean	shouldInlineBinaryData()
Object	valueFromRow(AbstractRecord row, JoinedAttributeManager joinManager, ObjectBuildingQuery query, CacheKey cacheKey, AbstractSession executionSession, boolean isTargetProtected, Boolean[] wasCacheUsed)	INTERNAL: Build the nested collection from the database row.
void	writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL:
void	writeSingleValue(Object value, Object parent, XMLRecord record, 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.oxm.mappings.XMLCompositeDirectCollectionMapping

convertDataValueToObjectValue, convertObjectValueToDataValue, getNullPolicy, getNullValue, getReuseContainer, getWrapperNullPolicy, getXPath, initialize, isCDATA, isCollapsingStringValues, isDefaultEmptyContainer, isNormalizingStringValues, isWriteOnly, isXMLMapping, preInitialize, setAttributeValueInObject, setCollapsingStringValues, setDefaultEmptyContainer, setIsCDATA, setIsWriteOnly, setNormalizingStringValues, setNullPolicy, setNullValue, setReuseContainer, setWrapperNullPolicy, useCollectionClassName

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

buildAddedElementFromChangeSet, buildBackupClone, buildChangeSet, buildClone, buildCloneFromRow, buildClonePart, buildCopy, buildElementFromChangeSet, buildElementFromElement, buildRemovedElementFromChangeSet, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, collectFields, compareElements, compareElementsForChange, compareForChange, compareObjects, convertClassNamesToClasses, convertToChangeRecord, createMapComponentFromRow, fixObjectReferences, getContainerPolicy, getField, getFieldClassification, getFieldElementClass, getFieldName, getRealCollectionAttributeValueFromObject, getValueConverter, hasValueConverter, isCollectionMapping, iterate, mapKeyHasChanged, mergeChangesIntoObject, mergeIntoObject, setAttributeElementClassName, setContainerPolicy, setField, setFieldElementClass, setUsesSingleNode, setValueConverter, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, useCollectionClass, useListClassName, useMapClass, useMapClassName, usesSingleNode, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow

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

addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectQueryParameters, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getReferenceDescriptor, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasNestedIdentityReference, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, 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, toString, updateChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.mappings.structures.ArrayCollectionMapping

getAttributeName, setRealAttributeValueInObject

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

getNullPolicy, isWriteOnly, setField, setIsWriteOnly, setNullPolicy, setValueConverter, useCollectionClassName

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

getValueConverter, setField, setFieldElementClass, setUsesSingleNode, setValueConverter, usesSingleNode

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

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

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

getReuseContainer, getWrapperNullPolicy, isDefaultEmptyContainer, setDefaultEmptyContainer, setReuseContainer, setWrapperNullPolicy

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

convertDataValueToObjectValue, convertObjectValueToDataValue

Methods inherited from interface org.eclipse.persistence.oxm.mappings.XMLMapping

convertClassNamesToClasses

Constructor Detail

XMLBinaryDataCollectionMapping

public XMLBinaryDataCollectionMapping()

Method Detail

shouldInlineBinaryData

public boolean shouldInlineBinaryData()

Specified by:

shouldInlineBinaryData in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

setShouldInlineBinaryData

public void setShouldInlineBinaryData(boolean b)

Specified by:

setShouldInlineBinaryData in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

getMimeType

public String getMimeType(Object anObject)

INTERNAL

Specified by:

getMimeType in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

getMimeType

public String getMimeType()

INTERNAL

Specified by:

getMimeType in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

getMimeTypePolicy

public MimeTypePolicy getMimeTypePolicy()

Specified by:

getMimeTypePolicy in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

setMimeTypePolicy

public void setMimeTypePolicy(MimeTypePolicy mimeTypePolicy)

Allow implementer to set the MimeTypePolicy class FixedMimeTypePolicy or AttributeMimeTypePolicy (dynamic)

Specified by:

setMimeTypePolicy in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

Parameters:

mimeTypePolicy - MimeTypePolicy

setMimeType

public void setMimeType(String mimeTypeString)

Force mapping to set default FixedMimeTypePolicy using the MimeType string as argument

Parameters:

mimeTypeString -

isSwaRef

public boolean isSwaRef()

Specified by:

isSwaRef in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

setSwaRef

public void setSwaRef(boolean swaRef)

Specified by:

setSwaRef in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

isAbstractCompositeDirectCollectionMapping

public boolean isAbstractCompositeDirectCollectionMapping()

Description copied from class: AbstractCompositeDirectCollectionMapping

INTERNAL:

Specified by:

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

Overrides:

isAbstractCompositeDirectCollectionMapping in class AbstractCompositeDirectCollectionMapping

setXPath

public void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String

Specified by:

setXPath in interface DirectCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

Overrides:

setXPath in class XMLCompositeDirectCollectionMapping

Parameters:

xpathString - String

writeFromObjectIntoRow

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

Description copied from class: XMLCompositeDirectCollectionMapping

INTERNAL:

Overrides:

writeFromObjectIntoRow in class XMLCompositeDirectCollectionMapping

getValueToWrite

public Object getValueToWrite(Object value,
                              Object parent,
                              XMLRecord record,
                              XMLField field,
                              XMLField includeField,
                              AbstractSession session)

writeSingleValue

public void writeSingleValue(Object value,
                             Object parent,
                             XMLRecord record,
                             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

Overrides:

writeSingleValue in class XMLCompositeDirectCollectionMapping

Parameters:

value - - The value to be marshalled

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

valueFromRow

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

Description copied from class: XMLCompositeDirectCollectionMapping

INTERNAL: Build the nested collection from the database row.

Overrides:

valueFromRow in class XMLCompositeDirectCollectionMapping

setCollectionContentType

public void setCollectionContentType(Class javaClass)

getCollectionContentType

public Class getCollectionContentType()

setAttributeElementClass

public void setAttributeElementClass(Class attributeElementClass)

PUBLIC: Set the class each element in the object's collection should be converted to, before the collection is inserted into the object. This is optional - if left null, the elements will be added to the object's collection unconverted.

Specified by:

setAttributeElementClass in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

Specified by:

setAttributeElementClass in interface DirectCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

Overrides:

setAttributeElementClass in class AbstractCompositeDirectCollectionMapping

getAttributeElementClass

public Class getAttributeElementClass()

Description copied from class: AbstractCompositeDirectCollectionMapping

PUBLIC: Return the class each element in the object's collection should be converted to, before the collection is inserted into the object. This is optional - if left null, the elements will be added to the object's collection unconverted.

Specified by:

getAttributeElementClass in interface BinaryDataCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,MimeTypePolicy,Session,XMLUnmarshaller,XMLRecord>

Specified by:

getAttributeElementClass in interface DirectCollectionMapping<AbstractSession,AttributeAccessor,ContainerPolicy,Converter,ClassDescriptor,DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

Overrides:

getAttributeElementClass in class AbstractCompositeDirectCollectionMapping