Module org.eclipse.persistence.core

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

Interface ChoiceCollectionMapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,CONVERTER extends CoreConverter,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,MARSHALLER extends Marshaller,SESSION extends CoreSession,UNMARSHALLER extends Unmarshaller,XML_FIELD extends Field,XML_MAPPING extends Mapping,XML_RECORD extends XMLRecord>

All Superinterfaces:

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

All Known Implementing Classes:

XMLChoiceCollectionMapping

public interface ChoiceCollectionMapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,CONVERTER extends CoreConverter,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,MARSHALLER extends Marshaller,SESSION extends CoreSession,UNMARSHALLER extends Unmarshaller,XML_FIELD extends Field,XML_MAPPING extends Mapping,XML_RECORD extends XMLRecord>
extends Mapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,XML_RECORD>, XMLContainerMapping, XMLConverterMapping<MARSHALLER,SESSION,UNMARSHALLER>

Field Summary

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

EMPTY_CONTAINER_DEFAULT

Method Summary

Modifier and Type	Method	Description
void	addChoiceElement(String xpath, String elementTypeName)
void	addChoiceElement(String srcXpath, String elementTypeName, String tgtXpath)
void	addChoiceElement(List<XML_FIELD> srcFields, String elementTypeName, List<XML_FIELD> tgtFields)
void	addChoiceElement(XML_FIELD field, String elementTypeName)
void	addConverter(XML_FIELD field, CONVERTER converter)
AnyCollectionMapping	getAnyMapping()
Map<XML_FIELD,XML_MAPPING>	getChoiceElementMappings()
Map<Class<?>,XML_MAPPING>	getChoiceElementMappingsByClass()
List<XMLChoiceFieldToClassAssociation>	getChoiceFieldToClassAssociations()
Map<String,XML_FIELD>	getClassNameToFieldMappings()
Map<Class<?>,XML_FIELD>	getClassToFieldMappings()
Map<Class<?>,List<XML_FIELD>>	getClassToSourceFieldsMappings()
CONVERTER	getConverter()
CONVERTER	getConverter(XML_FIELD field)
Map<XML_FIELD,Class<?>>	getFieldToClassMappings()
XML_MAPPING	getMixedContentMapping()
boolean	isAny()
boolean	isMixedContent()
void	setConverter(CONVERTER converter)	Set the converter on the mapping.
void	setIsWriteOnly(boolean b)
void	setMixedContent(boolean mixed)	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)	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	useCollectionClassName(String concreteContainerClassName)

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.XMLContainerMapping

getReuseContainer, getWrapperNullPolicy, isDefaultEmptyContainer, setDefaultEmptyContainer, setReuseContainer, setWrapperNullPolicy

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

convertDataValueToObjectValue, convertObjectValueToDataValue

Method Details

addChoiceElement

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

addChoiceElement

void addChoiceElement(String xpath,
 String elementTypeName)

addChoiceElement

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

addChoiceElement

void addChoiceElement(XML_FIELD field,
 String elementTypeName)

addConverter

void addConverter(XML_FIELD field,
 CONVERTER converter)

getChoiceElementMappings

Map<XML_FIELD,XML_MAPPING> getChoiceElementMappings()

getChoiceElementMappingsByClass

Map<Class<?>,XML_MAPPING> getChoiceElementMappingsByClass()

getChoiceFieldToClassAssociations

List<XMLChoiceFieldToClassAssociation> getChoiceFieldToClassAssociations()

getClassNameToFieldMappings

Map<String,XML_FIELD> getClassNameToFieldMappings()

getClassToFieldMappings

Map<Class<?>,XML_FIELD> getClassToFieldMappings()

getClassToSourceFieldsMappings

Map<Class<?>,List<XML_FIELD>> getClassToSourceFieldsMappings()

getConverter

CONVERTER getConverter()

getConverter

CONVERTER getConverter(XML_FIELD field)

getFieldToClassMappings

Map<XML_FIELD,Class<?>> getFieldToClassMappings()

getMixedContentMapping

XML_MAPPING getMixedContentMapping()

isMixedContent

boolean isMixedContent()

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.

setIsWriteOnly

void setIsWriteOnly(boolean b)

setMixedContent

void setMixedContent(boolean mixed)

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

Since:

EclipseLink 2.3.1

setMixedContent

void setMixedContent(String groupingElement)

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.

Since:

EclipseLink 2.3.1

useCollectionClassName

void useCollectionClassName(String concreteContainerClassName)

isAny

boolean isAny()

getAnyMapping

AnyCollectionMapping getAnyMapping()