oracle.toplink.ox.mappings
Class XMLBinaryDataMapping

java.lang.Object
  oracle.toplink.mappings.DatabaseMapping
      oracle.toplink.mappings.foundation.AbstractDirectMapping
          oracle.toplink.ox.mappings.XMLDirectMapping
              oracle.toplink.ox.mappings.XMLBinaryDataMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.ox.mappings.XMLMapping, oracle.toplink.ox.mappings.XMLNillableMapping

public class XMLBinaryDataMapping
extends XMLDirectMapping

Purpose:Provide a mapping for binary data that can be treated as either inline 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)

XMLBinaryDataMapping represents a mapping 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 typed are allowable to be mapped using an XMLBinaryDataMapping:

• java.awt.Image
• byte[]
• javax.activation.DataHandler
• javax.xml.transform.Source
• javax.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

Field Summary

Fields inherited from class oracle.toplink.ox.mappings.XMLDirectMapping

isCDATA

Constructor Summary

XMLBinaryDataMapping()

Method Summary

MimeTypePolicy	getMimeTypePolicy()
boolean	isSwaRef()
void	setMimeType(java.lang.String mimeTypeString) Force mapping to set default FixedMimeTypePolicy using the MimeType string as argument
void	setMimeTypePolicy(MimeTypePolicy aPolicy) Allow implementer to set the MimeTypePolicy class FixedMimeTypePolicy or AttributeMimeTypePolicy (dynamic)
void	setShouldInlineBinaryData(boolean b)
void	setSwaRef(boolean swaRef)
void	setXPath(java.lang.String xpathString) Set the Mapping field name attribute to the given XPath String
boolean	shouldInlineBinaryData()

Methods inherited from class oracle.toplink.ox.mappings.XMLDirectMapping

getXPath, initialize, isCDATA, setAttributeValueInObject, setIsCDATA, setNullPolicy

Methods inherited from class oracle.toplink.mappings.foundation.AbstractDirectMapping

getAttributeClassification, getConverter, getFieldClassification, getFieldName, getNullValue, hasConverter, isMutable, setAttributeClassification, setConverter, setConverterClassName, setField, setFieldClassification, setFieldType, setIsMutable, setNullValue

Methods inherited from class oracle.toplink.mappings.DatabaseMapping

getAttributeAccessor, getAttributeName, getGetMethodName, getProperty, getReferenceDescriptor, getSetMethodName, isLazy, isOptional, isUsingMethodAccess, readOnly, readWrite, setAttributeAccessor, setAttributeName, setGetMethodName, setIsLazy, setIsOptional, setIsReadOnly, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLBinaryDataMapping

public XMLBinaryDataMapping()

Method Detail

shouldInlineBinaryData

public boolean shouldInlineBinaryData()

setShouldInlineBinaryData

public void setShouldInlineBinaryData(boolean b)

getMimeTypePolicy

public MimeTypePolicy getMimeTypePolicy()

setMimeTypePolicy

public void setMimeTypePolicy(MimeTypePolicy aPolicy)

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

Parameters:

aPolicy - MimeTypePolicy

setMimeType

public void setMimeType(java.lang.String mimeTypeString)

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

Parameters:

mimeTypeString -

isSwaRef

public boolean isSwaRef()

setSwaRef

public void setSwaRef(boolean swaRef)

setXPath

public void setXPath(java.lang.String xpathString)

Set the Mapping field name attribute to the given XPath String

Overrides:

setXPath in class XMLDirectMapping

Parameters:

xpathString - String