org.eclipse.persistence.internal.oxm.mappings

public Interface DirectCollectionMapping<ABSTRACT_SESSION extends CoreAbstractSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform<CONVERSION_MANAGER extends CoreConversionManager>, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager<SESSION_EVENT_LISTENER extends CoreSessionEventListener>>, ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, CONTAINER_POLICY extends CoreContainerPolicy<ABSTRACT_SESSION extends CoreAbstractSession>, CONVERTER extends CoreConverter<MAPPING extends CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>, SESSION extends CoreSession>, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField, MARSHALLER extends Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler, CONTEXT extends Context<ABSTRACT_SESSION extends CoreAbstractSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform<CONVERSION_MANAGER extends CoreConversionManager>, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager<SESSION_EVENT_LISTENER extends CoreSessionEventListener>>, DESCRIPTOR extends Descriptor<?, ?, ?, ?, ?, NAMESPACE_RESOLVER, ?, ?, ?, ?>, FIELD extends Field, NAMESPACE_RESOLVER extends NamespaceResolver, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION extends CoreSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager>, SESSION_EVENT_LISTENER extends CoreSessionEventListener>, MARSHALLER_LISTENER extends Marshaller.Listener, MEDIA_TYPE extends MediaType, NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>, SESSION extends CoreSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager>, UNMARSHALLER extends Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform<CONVERSION_MANAGER extends CoreConversionManager>, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager<SESSION_EVENT_LISTENER extends CoreSessionEventListener>>, CONTEXT extends Context<ABSTRACT_SESSION extends CoreAbstractSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform<CONVERSION_MANAGER extends CoreConversionManager>, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager<SESSION_EVENT_LISTENER extends CoreSessionEventListener>>, DESCRIPTOR extends Descriptor<?, ?, ?, ?, ?, NAMESPACE_RESOLVER, ?, ?, ?, ?>, FIELD extends Field, NAMESPACE_RESOLVER extends NamespaceResolver, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION extends CoreSession<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, PLATFORM extends CorePlatform, PROJECT extends CoreProject<DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, LOGIN extends CoreLogin<PLATFORM extends CorePlatform>, SESSION extends CoreSession>, SESSION_EVENT_MANAGER extends CoreSessionEventManager>, SESSION_EVENT_LISTENER extends CoreSessionEventListener>, DESCRIPTOR extends Descriptor, ID_RESOLVER extends IDResolver, MEDIA_TYPE extends MediaType, ROOT extends Root, UNMARSHALLER_HANDLER extends UnmarshallerHandler, UNMARSHALLER_LISTENER extends Unmarshaller.Listener>, XML_RECORD extends XMLRecord>

Known Direct Implementers: org.eclipse.persistence.oxm.mappings.XMLCompositeDirectCollectionMapping
Imports: org.eclipse.persistence.core.descriptors.CoreDescriptor, org.eclipse.persistence.core.mappings.CoreAttributeAccessor, org.eclipse.persistence.core.mappings.converters.CoreConverter, org.eclipse.persistence.core.sessions.CoreSession, org.eclipse.persistence.internal.core.helper.CoreField, org.eclipse.persistence.internal.core.queries.CoreContainerPolicy, org.eclipse.persistence.internal.core.sessions.CoreAbstractSession, org.eclipse.persistence.internal.oxm.Marshaller, .Unmarshaller, org.eclipse.persistence.internal.oxm.record.XMLRecord, org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy

Field Summary

Inherited from org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping:: EMPTY_CONTAINER_DEFAULT

Method Summary

Modifier and Type	Method and Description
public Class<?>	getAttributeElementClass() Return the class each element in the object's collection should be converted to, before the collection is inserted into the object.
public AbstractNullPolicy	getNullPolicy()
public Object	getNullValue()
public CONVERTER	getValueConverter() Return the converter on the mapping.
public boolean	isCDATA()
public boolean	isCollapsingStringValues()
public boolean	isNormalizingStringValues()
public void	setAttributeElementClass(Class<?> attributeElementClass) Set the class each element in the object's collection should be converted to, before the collection is inserted into the object.
public void	setCollapsingStringValues(boolean collapse) Indicates that this mapping should collapse all string values before adding them to the collection on unmarshal.
public void	setField(FIELD field) Set the field that holds the nested collection.
public void	setFieldElementClass(Class<?> fieldElementClass) PUBLIC: Set the class each element in the database row's collection should be converted to, before the collection is inserted into the database.
public void	setIsCDATA(boolean CDATA)
public void	setIsWriteOnly(boolean b)
public void	setNormalizingStringValues(boolean normalize) Indicates that this mapping should normalize all string values before adding them to the collection on unmarshal.
public void	setNullPolicy(AbstractNullPolicy nullPolicyFromProperty)
public void	setNullValue(Object nullValue)
public void	setUsesSingleNode(boolean True if the items in the collection are in a single node or false if each of the items in the collection is in its own node usesSingleNode) Sets whether the mapping uses a single node.
public void	setValueConverter(CONVERTER valueConverter) Set the converter on the mapping.
public void	setXPath(String String xpathString) Set the Mapping field name attribute to the given XPath String
public void	useCollectionClassName(String concreteContainerClassName)
public boolean	Returns: True if the items in the collection are in a single node or false if each of the items in the collection is in its own node. usesSingleNode() Checks whether the mapping uses a single node.

Inherited from 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
Inherited from org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping:: getReuseContainer getWrapperNullPolicy isDefaultEmptyContainer setDefaultEmptyContainer setReuseContainer setWrapperNullPolicy
Inherited from org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping:: convertDataValueToObjectValue convertObjectValueToDataValue

Method Detail

getAttributeElementClass	back to summary
public Class<?> getAttributeElementClass() 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.

getNullPolicy	back to summary
public AbstractNullPolicy getNullPolicy()

getNullValue	back to summary
public Object getNullValue()

getValueConverter	back to summary
public CONVERTER getValueConverter() Return the converter on the mapping. A converter can be used to convert between the direct collection's object value and database value.

isCDATA	back to summary
public boolean isCDATA()

isCollapsingStringValues	back to summary
public boolean isCollapsingStringValues()

isNormalizingStringValues	back to summary
public boolean isNormalizingStringValues()

setAttributeElementClass	back to summary
public void setAttributeElementClass(Class<?> attributeElementClass) 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.

setCollapsingStringValues	back to summary
public void setCollapsingStringValues(boolean collapse) Indicates that this mapping should collapse all string values before adding them to the collection on unmarshal. Collapse removes leading and trailing whitespaces, and replaces any sequence of whitespace characters with a single space.

setField	back to summary
public void setField(FIELD field) Set the field that holds the nested collection.

setFieldElementClass	back to summary
public void setFieldElementClass(Class<?> fieldElementClass) PUBLIC: Set the class each element in the database row's collection should be converted to, before the collection is inserted into the database. This is optional - if left null, the elements will be added to the database row's collection unconverted.

setIsCDATA	back to summary
public void setIsCDATA(boolean CDATA)

setIsWriteOnly	back to summary
public void setIsWriteOnly(boolean b)

setNormalizingStringValues	back to summary
public void setNormalizingStringValues(boolean normalize) Indicates that this mapping should normalize all string values before adding them to the collection on unmarshal. Normalize replaces any CR, LF or Tab characters with a single space character.

setNullPolicy	back to summary
public void setNullPolicy(AbstractNullPolicy nullPolicyFromProperty)

setNullValue	back to summary
public void setNullValue(Object nullValue)

setUsesSingleNode	back to summary
public void setUsesSingleNode(boolean usesSingleNode) Sets whether the mapping uses a single node. Parameters usesSingleNode:boolean True if the items in the collection are in a single node or false if each of the items in the collection is in its own node

setUsesSingleNode

back to summary

public void setUsesSingleNode(boolean usesSingleNode)

Sets whether the mapping uses a single node.

Parameters

usesSingleNode:boolean: True if the items in the collection are in a single node or false if each of the items in the collection is in its own node

setValueConverter	back to summary
public void setValueConverter(CONVERTER valueConverter) Set the converter on the mapping. A converter can be used to convert between the direct collection's object value and database value.

setXPath	back to summary
public void setXPath(String xpathString) Set the Mapping field name attribute to the given XPath String Parameters xpathString:String String

setXPath

back to summary

public void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String

Parameters

xpathString:String: String

useCollectionClassName	back to summary
public void useCollectionClassName(String concreteContainerClassName)

usesSingleNode	back to summary
public boolean usesSingleNode() Checks whether the mapping uses a single node. Returns:boolean True if the items in the collection are in a single node or false if each of the items in the collection is in its own node.

usesSingleNode

back to summary

public boolean usesSingleNode()

Checks whether the mapping uses a single node.

Returns:boolean: True if the items in the collection are in a single node or false if each of the items in the collection is in its own node.