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

public Class XMLVariableXPathObjectMapping

extends XMLCompositeObjectMapping
implements VariableXPathObjectMapping<AbstractSession, AttributeAccessor, ContainerPolicy, Converter, ClassDescriptor, DatabaseField, XMLMarshaller, Session, XMLUnmarshaller, XMLRecord>, XMLMapping
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.oxm.mappings.XMLMapping, org.eclipse.persistence.internal.oxm.mappings.Mapping, org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping, org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping
Imports
java.util.Vector, javax.xml.namespace.QName, org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.exceptions.DescriptorException, 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.VariableXPathObjectMapping, org.eclipse.persistence.internal.queries.ContainerPolicy, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.mappings.AttributeAccessor, org.eclipse.persistence.mappings.converters.Converter, org.eclipse.persistence.oxm.XMLConstants, .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.XMLCompositeObjectMapping:
nullPolicy

Constructor Summary

AccessConstructor and Description
public
XMLVariableXPathObjectMapping()

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.AbstractCompositeObjectMapping.collectFields.

Return the fields mapped 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 namespaceSep)

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

public void
initialize(AbstractSession session)

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

INTERNAL: The mapping is initialized with the given session.
protected void
initializeReferenceDescriptorAndField(AbstractSession session)

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

public boolean
isAbstractCompositeObjectMapping()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.isAbstractCompositeObjectMapping.

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

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
writeSingleValue(Object
- The value to be marshalled
value, Object parent, XMLRecord
- The Record the value is being marshalled too.
xmlRow, AbstractSession session)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeObjectMapping.writeSingleValue.

Implements org.eclipse.persistence.internal.oxm.mappings.Mapping.writeSingleValue, org.eclipse.persistence.oxm.mappings.XMLMapping.writeSingleValue.

INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath.
Inherited from org.eclipse.persistence.oxm.mappings.XMLCompositeObjectMapping:
buildCompositeObjectbuildCompositeRowbuildCompositeRowForDescriptorconfigureNestedRowconvertClassNamesToClassesconvertDataValueToObjectValueconvertObjectValueToDataValuegetContainerAccessorgetContainerAttributeNamegetContainerGetMethodNamegetContainerSetMethodNamegetDescriptorgetInverseReferenceMappinggetKeepAsElementPolicygetNullPolicygetReferenceDescriptorgetReferenceDescriptorgetXPathisWriteOnlyisXMLMappingpreInitializereadFromRowIntoObjectsetAttributeValueInObjectsetContainerAccessorsetContainerAttributeNamesetContainerGetMethodNamesetContainerSetMethodNamesetInverseReferenceMappingsetIsWriteOnlysetKeepAsElementPolicysetNullPolicysetXPathvalueFromRowvalueFromRowwriteFromObjectIntoRow

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

XMLVariableXPathObjectMappingback to summary
public XMLVariableXPathObjectMapping()

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.AbstractCompositeObjectMapping.collectFields.

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

Return the fields mapped 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 namespaceSep)

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.XMLCompositeObjectMapping.initialize.

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

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

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

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

Annotations
@Override
isAbstractCompositeObjectMappingback to summary
public boolean isAbstractCompositeObjectMapping()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.isAbstractCompositeObjectMapping.

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

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

Related mapping should implement this method to return true.

Returns:boolean

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

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
writeSingleValueback to summary
public void writeSingleValue(Object value, Object parent, XMLRecord xmlRow, AbstractSession session)

Overrides org.eclipse.persistence.oxm.mappings.XMLCompositeObjectMapping.writeSingleValue.

Implements org.eclipse.persistence.internal.oxm.mappings.Mapping.writeSingleValue, org.eclipse.persistence.oxm.mappings.XMLMapping.writeSingleValue.

Doc from org.eclipse.persistence.oxm.mappings.XMLMapping.writeSingleValue.

INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath. Used for Sequenced marshalling.

Parameters
value:Object

- The value to be marshalled

xmlRow:XMLRecord

- The Record the value is being marshalled too.

Annotations
@Override