Top Fields Constructors Methods
org.eclipse.persistence.oxm.mappings

public Class XMLVariableXPathCollectionMapping

extends XMLCompositeCollectionMapping
implements VariableXPathCollectionMapping<AbstractSession, AttributeAccessor, ContainerPolicy, Converter, ClassDescriptor, DatabaseField, XMLMarshaller, Session, XMLUnmarshaller, XMLRecord>, XMLMapping, XMLContainerMapping
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping, org.eclipse.persistence.oxm.mappings.XMLMapping, org.eclipse.persistence.internal.oxm.mappings.Mapping, org.eclipse.persistence.internal.oxm.mappings.VariableXPathCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping, org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping
Imports
java.util.Vector, javax.xml.namespace.QName, org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.exceptions.DescriptorException, .XMLMarshalException, org.eclipse.persistence.internal.descriptors.InstanceVariableAttributeAccessor, .MethodAttributeAccessor, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.oxm.NamespaceResolver, .XPathFragment, org.eclipse.persistence.internal.oxm.mappings.VariableXPathCollectionMapping, .XMLContainerMapping, org.eclipse.persistence.internal.queries.ContainerPolicy, .MapContainerPolicy, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.mappings.AttributeAccessor, org.eclipse.persistence.mappings.converters.Converter, org.eclipse.persistence.oxm.XMLField, .XMLMarshaller, .XMLUnmarshaller, org.eclipse.persistence.oxm.record.XMLRecord, org.eclipse.persistence.sessions.Session

Field Summary

Modifier and TypeField and Description
private boolean
isAttribute

private AttributeAccessor
variableAttributeAccessor

protected String
variableAttributeName

protected String
variableGetMethodName

protected String
variableSetMethodName

Inherited from org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping:
nullPolicy

Constructor Summary

AccessConstructor and Description
public
XMLVariableXPathCollectionMapping()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
protected AbstractRecord
buildCompositeRow(XMLField variableField, Object attributeValue, AbstractSession session, AbstractRecord parentRow, DatabaseMapping.WriteType writeType)

protected Vector<E>
collectFields()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.collectFields.

Return the fields handled by the mapping.
public Vector<E>
getFields()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.getFields.

INTERNAL: Returns a vector of all the fields this mapping represents.
public AttributeAccessor
getVariableAttributeAccessor()

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.getVariableAttributeAccessor.

public String
getVariableAttributeName()

public String
getVariableGetMethodName()

public String
getVariableSetMethodName()

public XPathFragment<XML_FIELD extends Field>
getXPathFragmentForValue(Object obj, NamespaceResolver nr, boolean isNamespaceAware, char sep)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.getXPathFragmentForValue.

public void
initialize(AbstractSession session)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initialize.

INTERNAL: The mapping is initialized with the given session.
protected void
initializeMapContainerPolicy(AbstractSession session, MapContainerPolicy cp)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initializeMapContainerPolicy.

protected void
initializeReferenceDescriptorAndField(AbstractSession session)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initializeReferenceDescriptorAndField.

public boolean
isAbstractCompositeCollectionMapping()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.isAbstractCompositeCollectionMapping.

Implements org.eclipse.persistence.internal.oxm.mappings.Mapping.isAbstractCompositeCollectionMapping.

Related mapping should implement this method to return true.
public boolean
isAttribute()

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.isAttribute.

public void
setAttribute(boolean isAttribute)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setAttribute.

public void
setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableAttributeAccessor.

public void
setVariableAttributeName(String variableAttributeName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableAttributeName.

public void
setVariableGetMethodName(String variableGetMethodName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableGetMethodName.

public void
setVariableSetMethodName(String variableSetMethodName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableSetMethodName.

public void
useMapClass(String concreteContainerClassName)

public void
useMapClassName(String concreteContainerClassName, String methodName)

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.useMapClassName.

Implements org.eclipse.persistence.mappings.ContainerMapping.useMapClassName.

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
public void
writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.writeFromObjectIntoRow.

INTERNAL:
Inherited from org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping:
buildCompositeObjectbuildCompositeRowbuildCompositeRowForDescriptorbuildObjectFromNestedRowconvertClassNamesToClassesconvertDataValueToObjectValueconvertObjectValueToDataValuegetContainerAccessorgetContainerAttributeNamegetContainerGetMethodNamegetContainerSetMethodNamegetDescriptorgetInverseReferenceMappinggetKeepAsElementPolicygetNullPolicygetReferenceDescriptorgetReferenceDescriptorgetReuseContainergetWrapperNullPolicygetXPathisDefaultEmptyContainerisWriteOnlyisXMLMappingpreInitializesetAttributeValueInObjectsetContainerAccessorsetContainerAttributeNamesetContainerGetMethodNamesetContainerSetMethodNamesetDefaultEmptyContainersetInverseReferenceMappingsetIsWriteOnlysetKeepAsElementPolicysetNullPolicysetReuseContainersetWrapperNullPolicysetXPathvalueFromRowwriteSingleValue

Field Detail

isAttributeback to summary
private boolean isAttribute
variableAttributeAccessorback to summary
private AttributeAccessor variableAttributeAccessor
variableAttributeNameback to summary
protected String variableAttributeName
variableGetMethodNameback to summary
protected String variableGetMethodName
variableSetMethodNameback to summary
protected String variableSetMethodName

Constructor Detail

XMLVariableXPathCollectionMappingback to summary
public XMLVariableXPathCollectionMapping()

Default constructor.

Method Detail

buildCompositeRowback to summary
protected AbstractRecord buildCompositeRow(XMLField variableField, Object attributeValue, AbstractSession session, AbstractRecord parentRow, DatabaseMapping.WriteType writeType)
collectFieldsback to summary
protected Vector<E> collectFields()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.collectFields.

Doc from org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.collectFields.

Return the fields handled by the mapping.

Returns:Vector<E>

Doc from org.eclipse.persistence.mappings.DatabaseMapping.collectFields.

TODO

Annotations
@Override
getFieldsback to summary
public Vector<E> getFields()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.getFields.

Doc from org.eclipse.persistence.mappings.DatabaseMapping.getFields.

INTERNAL: Returns a vector of all the fields this mapping represents.

Returns:Vector<E>

TODO

Annotations
@Override
getVariableAttributeAccessorback to summary
public AttributeAccessor getVariableAttributeAccessor()

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.getVariableAttributeAccessor.

Annotations
@Override
getVariableAttributeNameback to summary
public String getVariableAttributeName()
getVariableGetMethodNameback to summary
public String getVariableGetMethodName()
getVariableSetMethodNameback to summary
public String getVariableSetMethodName()
getXPathFragmentForValueback to summary
public XPathFragment<XML_FIELD extends Field> getXPathFragmentForValue(Object obj, NamespaceResolver nr, boolean isNamespaceAware, char sep)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.getXPathFragmentForValue.

Annotations
@Override
initializeback to summary
public void initialize(AbstractSession session) throws DescriptorException

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initialize.

Doc from org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initialize.

INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.

Annotations
@Override
initializeMapContainerPolicyback to summary
protected void initializeMapContainerPolicy(AbstractSession session, MapContainerPolicy cp)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initializeMapContainerPolicy.

Annotations
@Override
initializeReferenceDescriptorAndFieldback to summary
protected void initializeReferenceDescriptorAndField(AbstractSession session)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.initializeReferenceDescriptorAndField.

Annotations
@Override
isAbstractCompositeCollectionMappingback to summary
public boolean isAbstractCompositeCollectionMapping()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.isAbstractCompositeCollectionMapping.

Implements org.eclipse.persistence.internal.oxm.mappings.Mapping.isAbstractCompositeCollectionMapping.

Doc from org.eclipse.persistence.internal.oxm.mappings.Mapping.isAbstractCompositeCollectionMapping.

Related mapping should implement this method to return true.

Returns:boolean

Doc from org.eclipse.persistence.core.mappings.CoreMapping.isAbstractCompositeCollectionMapping.

TODO

Annotations
@Override
isAttributeback to summary
public boolean isAttribute()

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.isAttribute.

Annotations
@Override
setAttributeback to summary
public void setAttribute(boolean isAttribute)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setAttribute.

Annotations
@Override
setVariableAttributeAccessorback to summary
public void setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableAttributeAccessor.

Annotations
@Override
setVariableAttributeNameback to summary
public void setVariableAttributeName(String variableAttributeName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableAttributeName.

Annotations
@Override
setVariableGetMethodNameback to summary
public void setVariableGetMethodName(String variableGetMethodName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableGetMethodName.

Annotations
@Override
setVariableSetMethodNameback to summary
public void setVariableSetMethodName(String variableSetMethodName)

Implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping.setVariableSetMethodName.

Annotations
@Override
useMapClassback to summary
public void useMapClass(String concreteContainerClassName)
useMapClassNameback to summary
public void useMapClassName(String concreteContainerClassName, String methodName)

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping.useMapClassName.

Implements org.eclipse.persistence.mappings.ContainerMapping.useMapClassName.

Doc from org.eclipse.persistence.mappings.ContainerMapping.useMapClassName.

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects. The key used to index a value in the Map is the value returned by a call to the specified zero-argument method. The method must be implemented by the class (or a superclass) of any value to be inserted into the Map.

The container class must implement (directly or indirectly) the java.util.Map interface.

To facilitate resolving the method, the mapping's referenceClass must set before calling this method.

Annotations
@Override
writeFromObjectIntoRowback to summary
public void writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType) throws DescriptorException

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.writeFromObjectIntoRow.

Doc from org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping.writeFromObjectIntoRow.

INTERNAL:

Annotations
@Override