java.lang.Object
- org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField>
- - org.eclipse.persistence.mappings.DatabaseMapping
  - - org.eclipse.persistence.mappings.AggregateMapping
    - - org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping
      - org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping
        
        org.eclipse.persistence.oxm.mappings.XMLVariableXPathCollectionMapping

All Implemented Interfaces:

Serializable, Cloneable, org.eclipse.persistence.internal.oxm.mappings.CompositeCollectionMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,UnmarshalKeepAsElementPolicy,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.CompositeObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,UnmarshalKeepAsElementPolicy,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.VariableXPathCollectionMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping, org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>, ContainerMapping, ArrayCollectionMapping, XMLMapping, XMLNillableMapping
```
public class XMLVariableXPathCollectionMapping
extends XMLCompositeCollectionMapping
implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathCollectionMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, XMLMapping, org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping
  DatabaseMapping.WriteType

Field Summary
- Fields inherited from interface org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping
  EMPTY_CONTAINER_DEFAULT

Constructor Summary

Constructors
Constructor Description

XMLVariableXPathCollectionMapping()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Vector`	`getFields()`	INTERNAL: Returns a vector of all the fields this mapping represents.
`AttributeAccessor`	`getVariableAttributeAccessor()`
`String`	`getVariableAttributeName()`
`String`	`getVariableGetMethodName()`
`String`	`getVariableSetMethodName()`
`org.eclipse.persistence.internal.oxm.XPathFragment`	`getXPathFragmentForValue(Object obj, org.eclipse.persistence.internal.oxm.NamespaceResolver nr, boolean isNamespaceAware, char sep)`
`void`	`initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)`	INTERNAL: The mapping is initialized with the given session.
`boolean`	`isAbstractCompositeCollectionMapping()`	INTERNAL:
`boolean`	`isAttribute()`
`void`	`setAttribute(boolean isAttribute)`
`void`	`setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)`
`void`	`setVariableAttributeName(String variableAttributeName)`
`void`	`setVariableGetMethodName(String variableGetMethodName)`
`void`	`setVariableSetMethodName(String variableSetMethodName)`
`void`	`useMapClass(String concreteContainerClassName)`
`void`	`useMapClassName(String concreteContainerClassName, String methodName)`	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`writeFromObjectIntoRow(Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)`	INTERNAL:

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping
buildAddedElementFromChangeSet, buildChangeSet, buildElementFromElement, buildExpression, buildRemovedElementFromChangeSet, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, compareElements, compareElementsForChange, compareForChange, compareObjects, createMapComponentFromRow, getContainerPolicy, getConverter, getField, getRealCollectionAttributeValueFromObject, hasConverter, isCollectionMapping, mapKeyHasChanged, mergeChangesIntoObject, mergeIntoObject, postDeleteAttributeValue, postInsertAttributeValue, postUpdateAttributeValue, preDeleteAttributeValue, preInsertAttributeValue, preUpdateAttributeValue, setContainerPolicy, setConverter, setField, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, useCollectionClass, useCollectionClassName, useListClassName, useMapClass, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow

Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping
buildBackupClone, buildClone, buildCloneFromRow, buildCopy, fixObjectReferences, getReferenceClass, getReferenceClassName, getReferenceDescriptor, hasNestedIdentityReference, isAggregateMapping, iterate, load, loadAll, postDelete, postInsert, postUpdate, preDelete, preInsert, preUpdate, remoteInitialization, setReferenceClass, setReferenceClassName, updateChangeRecord, verifyDelete

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping
addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, collectQueryParameters, createCloneValueHolder, derivesId, earlyPreDelete, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getFieldClassification, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitialize, postInitializeSourceAndTargetExpressions, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, toString, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.mappings.structures.ArrayCollectionMapping
getAttributeName, setRealAttributeValueInObject

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.CompositeCollectionMapping
useCollectionClass, useCollectionClassName

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.CompositeObjectMapping
getReferenceClass, getReferenceClassName, hasConverter, setConverter, setField, setReferenceClass, setReferenceClassName

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Mapping
getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDescriptor, getField, getReferenceDescriptor, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setGetMethodName, setIsReadOnly, setProperties, setSetMethodName

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping
setConverter, setIsWriteOnly, setReferenceClassName

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

Methods inherited from interface org.eclipse.persistence.oxm.mappings.XMLMapping
convertClassNamesToClasses, isWriteOnly, setIsWriteOnly, writeSingleValue

- Constructor Detail
  - XMLVariableXPathCollectionMapping
```
public XMLVariableXPathCollectionMapping()
```
- Method Detail
  - initialize
```
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException
```
    Description copied from class: XMLCompositeCollectionMapping
    
    INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.
    
    Overrides:
    
    initialize in class XMLCompositeCollectionMapping
    
    Throws:
    
    DescriptorException
  - useMapClass
```
public void useMapClass(String concreteContainerClassName)
```
  - getFields
```
public Vector getFields()
```
    Description copied from class: DatabaseMapping
    
    INTERNAL: Returns a vector of all the fields this mapping represents.
    
    Overrides:
    
    getFields in class DatabaseMapping
  - isAbstractCompositeCollectionMapping
```
public boolean isAbstractCompositeCollectionMapping()
```
    Description copied from class: AbstractCompositeCollectionMapping
    
    INTERNAL:
    
    Specified by:
    
    isAbstractCompositeCollectionMapping in interface org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>
    
    Overrides:
    
    isAbstractCompositeCollectionMapping in class AbstractCompositeCollectionMapping
  - getVariableAttributeName
```
public String getVariableAttributeName()
```
  - setVariableAttributeName
```
public void setVariableAttributeName(String variableAttributeName)
```
    Specified by:
    
    setVariableAttributeName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - getVariableGetMethodName
```
public String getVariableGetMethodName()
```
  - setVariableGetMethodName
```
public void setVariableGetMethodName(String variableGetMethodName)
```
    Specified by:
    
    setVariableGetMethodName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - getVariableSetMethodName
```
public String getVariableSetMethodName()
```
  - setVariableSetMethodName
```
public void setVariableSetMethodName(String variableSetMethodName)
```
    Specified by:
    
    setVariableSetMethodName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - getVariableAttributeAccessor
```
public AttributeAccessor getVariableAttributeAccessor()
```
    Specified by:
    
    getVariableAttributeAccessor in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - setVariableAttributeAccessor
```
public void setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)
```
    Specified by:
    
    setVariableAttributeAccessor in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - writeFromObjectIntoRow
```
public void writeFromObjectIntoRow(Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)
                            throws DescriptorException
```
    Description copied from class: XMLCompositeCollectionMapping
    
    INTERNAL:
    
    Overrides:
    
    writeFromObjectIntoRow in class XMLCompositeCollectionMapping
    
    Throws:
    
    DescriptorException
  - getXPathFragmentForValue
```
public org.eclipse.persistence.internal.oxm.XPathFragment getXPathFragmentForValue(Object obj,
                                                                                   org.eclipse.persistence.internal.oxm.NamespaceResolver nr,
                                                                                   boolean isNamespaceAware,
                                                                                   char sep)
```
    Specified by:
    
    getXPathFragmentForValue in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - isAttribute
```
public boolean isAttribute()
```
    Specified by:
    
    isAttribute in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - setAttribute
```
public void setAttribute(boolean isAttribute)
```
    Specified by:
    
    setAttribute in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>
  - useMapClassName
```
public void useMapClassName(String concreteContainerClassName,
                            String methodName)
```
    Description copied from interface: ContainerMapping
    
    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.
    
    Specified by:
    
    useMapClassName in interface ContainerMapping
    
    Overrides:
    
    useMapClassName in class AbstractCompositeCollectionMapping

Class XMLVariableXPathCollectionMapping

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping

Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.mappings.structures.ArrayCollectionMapping

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

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

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

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

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

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

Methods inherited from interface org.eclipse.persistence.oxm.mappings.XMLMapping

Constructor Detail

XMLVariableXPathCollectionMapping

Method Detail

initialize

useMapClass

getFields

isAbstractCompositeCollectionMapping

getVariableAttributeName

setVariableAttributeName

getVariableGetMethodName

setVariableGetMethodName

getVariableSetMethodName

setVariableSetMethodName

getVariableAttributeAccessor

setVariableAttributeAccessor

writeFromObjectIntoRow

getXPathFragmentForValue

isAttribute

setAttribute

useMapClassName