Package org.eclipse.persistence.internal.oxm.mappings

Interface BinaryDataMapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,CONVERTER extends CoreConverter,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,MARSHALLER extends Marshaller,MIME_TYPE_POLICY extends MimeTypePolicy,SESSION extends CoreSession,UNMARSHALLER extends Unmarshaller,XML_RECORD extends XMLRecord>

All Superinterfaces:

Mapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,XML_RECORD>, XMLConverterMapping<MARSHALLER,SESSION,UNMARSHALLER>

All Known Implementing Classes:

XMLBinaryDataMapping

public interface BinaryDataMapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,CONVERTER extends CoreConverter,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,MARSHALLER extends Marshaller,MIME_TYPE_POLICY extends MimeTypePolicy,SESSION extends CoreSession,UNMARSHALLER extends Unmarshaller,XML_RECORD extends XMLRecord>
extends Mapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,XML_RECORD>, XMLConverterMapping<MARSHALLER,SESSION,UNMARSHALLER>

Method Summary

Modifier and Type	Method	Description
String	getMimeType()	INTERNAL
String	getMimeType(Object object)
AbstractNullPolicy	getNullPolicy()
Object	getObjectValue(Object object, SESSION session)
String	getXPath()	Get the XPath String
boolean	isSwaRef()
void	setAttributeClassification(Class attributeClassification)	Some databases do not properly support all of the base data types.
void	setAttributeClassificationName(String attributeClassificationName)	INTERNAL: Set the name of the class for MW usage.
void	setConverter(CONVERTER converter)	Set the converter on the mapping.
void	setField(FIELD theField)	ADVANCED: Set the field in the mapping.
void	setIsWriteOnly(boolean b)
void	setMimeType(String mimeTypeString)	Force mapping to set default FixedMimeTypePolicy using the MimeType string as argument
void	setMimeTypePolicy(MIME_TYPE_POLICY aPolicy)	Allow implementer to set the MimeTypePolicy class FixedMimeTypePolicy or AttributeMimeTypePolicy (dynamic)
void	setNullPolicy(AbstractNullPolicy aNullPolicy)	Set the AbstractNullPolicy on the mapping The default policy is NullPolicy.
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()

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

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

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

convertDataValueToObjectValue, convertObjectValueToDataValue

Method Detail

getMimeType

String getMimeType()

INTERNAL

getMimeType

String getMimeType(Object object)

getNullPolicy

AbstractNullPolicy getNullPolicy()

getObjectValue

Object getObjectValue(Object object,
                      SESSION session)

getXPath

String getXPath()

Get the XPath String

Returns:

String the XPath String associated with this Mapping

isSwaRef

boolean isSwaRef()

setAttributeClassification

void setAttributeClassification(Class attributeClassification)

Some databases do not properly support all of the base data types. For these databases, the base data type must be explicitly specified in the mapping to tell EclipseLink to force the instance variable value to that data type

setAttributeClassificationName

void setAttributeClassificationName(String attributeClassificationName)

INTERNAL: Set the name of the class for MW usage.

setConverter

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.

setField

void setField(FIELD 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.

setIsWriteOnly

void setIsWriteOnly(boolean b)

setMimeType

void setMimeType(String mimeTypeString)

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

Parameters:

mimeTypeString -

setMimeTypePolicy

void setMimeTypePolicy(MIME_TYPE_POLICY aPolicy)

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

Parameters:

aPolicy - MimeTypePolicy

setNullPolicy

void setNullPolicy(AbstractNullPolicy aNullPolicy)

Set the AbstractNullPolicy on the mapping
The default policy is NullPolicy.

Parameters:

aNullPolicy -

setShouldInlineBinaryData

void setShouldInlineBinaryData(boolean b)

setSwaRef

void setSwaRef(boolean swaRef)

setXPath

void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String

Parameters:

xpathString - String

shouldInlineBinaryData

boolean shouldInlineBinaryData()