public class XMLTransformationMapping extends AbstractTransformationMapping implements org.eclipse.persistence.internal.oxm.mappings.TransformationMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.record.XMLTransformationRecord,XMLRecord>, XMLMapping
Transformation XML mappings are used to create a custom mapping where one or more XML nodes can be used to create the object to be stored in a Java class's attribute. To handle the custom requirements at marshal (write) and unmarshall (read) time, a transformation mapping takes instances of org.eclipse.persistence.mappings.transformers (such as AttributeTransformer and FieldTransformer), providing a non-intrusive solution that avoids the need for domain objects to implement any 'special' interfaces.
Setting the XPath: TopLink XML mappings make use of XPath statements to find the relevant
data in an XML document. The XPath statement is relative to the context node specified in the descriptor.
The XPath may contain node type, path, and positional information. The XPath is specified on the
field transformer that is set on the mapping. The XPath is set as the first parameter of the
addFieldTransformer method.
The following XPath statements may be used to specify the location of XML data relating to an object's name attribute:
| XPath | Description |
|---|---|
| @name | The "@" character indicates that the node is an attribute. |
| text() | "text()" indicates that the node is a text node. In this case the name value in the text node belongs to the context node. |
| full-name/text() | The name information is stored in the text node of the full-name element. |
| personal-info/name/text() | The XPath statement may be used to specify any valid path. |
| name[2]/text() | The XPath statement may contain positional information. In this case the name information is stored in the text node of the second occurrence of the name element. |
Mapping a transformation: A transformer can be configured to perform both the XML instance-to-Java attribute transformation at unmarshall time (via attribute transformer) and the Java attribute-to-XML instance transformation at marshal time (via field transformer).
XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="employee" type="employee-type"/>
<xsd:complexType name="employee-type">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="normal-hours" type="normal-hours-type"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="normal-hours-type">
<xsd:sequence>
<xsd:element name="start-time" type="xsd:string"/>
<xsd:element name="end-time" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
Code Sample
XMLTransformationMapping mapping = new XMLTransformationMapping();
mapping.setAttributeName("normalHours");
mapping.setAttributeTransformerClassName("org.eclipse.persistence.testing.oxm.mappings.transformation.NormalHoursAttributeTransformer");
mapping.addFieldTransformer("normal-hours/start-time/text()", new StartTimeTransformer());
mapping.addFieldTransformer("normal-hours/end-time/text()", new EndTimeTransformer()");
More Information: For more information about using the XML Transformation Mapping, see the "Understanding XML Mappings" chapter of the Oracle TopLink Developer's Guide.
DatabaseMapping.WriteTypeattributeTransformer, attributeTransformerClassName, fieldToTransformers, fieldTransformations, indirectionPolicy, isMutableattributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isInSopObject, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, unconvertedProperties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM| Constructor and Description |
|---|
XMLTransformationMapping() |
| Modifier and Type | Method and Description |
|---|---|
void |
addFieldTransformation(java.lang.String fieldName,
java.lang.String methodName)
PUBLIC:
Add the name of field and the name of the method
that returns the value to be placed in said field
when the object is written to the database.
|
void |
addFieldTransformer(java.lang.String fieldName,
FieldTransformer transformer)
PUBLIC:
Add the name of field and the transformer
that returns the value to be placed in the field
when the object is written to the database.
|
void |
addFieldTransformerClassName(java.lang.String fieldName,
java.lang.String className)
INTERNAL:
Add the name of a field and the name of a class which implements
the FieldTransformer interface.
|
boolean |
isXMLMapping()
INTERNAL:
|
void |
preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL:
Allow for initialization of properties and validation.
|
java.lang.Object |
readFromRowIntoObject(XMLRecord row,
java.lang.Object object,
org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
boolean isTargetProtected)
INTERNAL:
Extract value from the row and set the attribute to the value in the object.
|
void |
setIsWriteOnly(boolean b) |
void |
writeFromAttributeIntoRow(org.eclipse.persistence.internal.oxm.record.UnmarshalRecord unmarshalRecord,
org.eclipse.persistence.internal.oxm.mappings.Field field,
java.lang.Object value,
boolean isElement)
INTERNAL:
Put value into a record keyed on field.
|
void |
writeSingleValue(java.lang.Object value,
java.lang.Object parent,
XMLRecord row,
org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL:
A method that marshals a single value to the provided Record based on this mapping's
XPath.
|
addFieldTransformation, addFieldTransformer, addFieldTransformerClassName, areObjectsToBeProcessedInstantiated, buildBackupClone, buildBackupCloneForPartObject, buildChangeRecord, buildClone, buildCloneForPartObject, buildCloneFromRow, buildCopy, buildPhantomRowFrom, buildShallowOriginalFromRow, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, clone, collectFields, compareForChange, compareObjects, convertClassNamesToClasses, createCloneValueHolder, dontUseIndirection, fixObjectReferences, getAttributeMethodName, getAttributeTransformer, getAttributeTransformerClass, getAttributeTransformerClassName, getAttributeValueFromObject, getFieldNameToMethodNameAssociations, getFieldNameToMethodNames, getFieldToTransformers, getFieldTransformations, getIndirectionPolicy, getRealAttributeValueFromAttribute, getValueFromRemoteValueHolder, initialize, initializeAttributeTransformer, initializeFieldToTransformers, instantiateAttribute, internalBuildChangeRecord, invokeAttributeTransformer, invokeFieldTransformer, invokeFieldTransformer, isAttributeValueFromObjectInstantiated, isChangeTrackingSupported, isMutable, isReadOnly, isTransformationMapping, isWriteOnly, iterate, iterateOnRealAttributeValue, mergeChangesIntoObject, mergeIntoObject, readFromReturnRowIntoObject, readFromRowIntoObject, remoteInitialization, setAttributeTransformation, setAttributeTransformer, setAttributeTransformerClass, setAttributeTransformerClassName, setAttributeValueInObject, setFieldNameToMethodNameAssociations, setFieldToTransformers, setFieldTransformations, setIndirectionPolicy, setIsMutable, setRealAttributeValueInObject, setUsesIndirection, updateChangeRecord, useBasicIndirection, useContainerIndirection, useIndirection, usesIndirection, validateBeforeInitialization, valueFromObject, writeFromObjectIntoRow, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRowaddUnconvertedProperty, buildContainerClone, buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cloneFields, collectQueryParameters, convertConverterClassNamesToClasses, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getContainerPolicy, getDerivedIdMapping, getDescriptor, getField, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getReferenceDescriptor, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasNestedIdentityReference, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isCloningRequired, isCollectionMapping, 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, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, load, loadAll, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInitializeSourceAndTargetExpressions, postInsert, postUpdate, preDelete, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, updateCollectionChangeRecord, validateAfterInitialization, valueFromResultSet, valueFromRow, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRowequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetFieldToTransformers, setAttributeTransformation, setAttributeTransformerClassName, setIsOptionalconvertClassNamesToClasses, isWriteOnlygetAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDescriptor, getField, getReferenceDescriptor, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setGetMethodName, setIsReadOnly, setProperties, setSetMethodNamepublic boolean isXMLMapping()
isXMLMapping in class DatabaseMappingpublic void addFieldTransformer(java.lang.String fieldName,
FieldTransformer transformer)
AbstractTransformationMappingaddFieldTransformer in class AbstractTransformationMappingpublic void addFieldTransformerClassName(java.lang.String fieldName,
java.lang.String className)
AbstractTransformationMappingaddFieldTransformerClassName in interface org.eclipse.persistence.internal.oxm.mappings.TransformationMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.record.XMLTransformationRecord,XMLRecord>addFieldTransformerClassName in class AbstractTransformationMappingpublic void addFieldTransformation(java.lang.String fieldName,
java.lang.String methodName)
AbstractTransformationMappingorg.eclipse.persistence.sessions.Session.addFieldTransformation in interface org.eclipse.persistence.internal.oxm.mappings.TransformationMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.record.XMLTransformationRecord,XMLRecord>addFieldTransformation in class AbstractTransformationMappingpublic void writeSingleValue(java.lang.Object value,
java.lang.Object parent,
XMLRecord row,
org.eclipse.persistence.internal.sessions.AbstractSession session)
XMLMappingwriteSingleValue 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>writeSingleValue in interface XMLMappingvalue - - The value to be marshalledrow - - The Record the value is being marshalled too.public void setIsWriteOnly(boolean b)
setIsWriteOnly in interface XMLMappingpublic void preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws DescriptorException
AbstractTransformationMappingpreInitialize in class AbstractTransformationMappingDescriptorExceptionpublic void writeFromAttributeIntoRow(org.eclipse.persistence.internal.oxm.record.UnmarshalRecord unmarshalRecord,
org.eclipse.persistence.internal.oxm.mappings.Field field,
java.lang.Object value,
boolean isElement)
writeFromAttributeIntoRow in interface org.eclipse.persistence.internal.oxm.mappings.TransformationMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.record.XMLTransformationRecord,XMLRecord>public java.lang.Object readFromRowIntoObject(XMLRecord row, java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected) throws DatabaseException
readFromRowIntoObject in interface org.eclipse.persistence.internal.oxm.mappings.TransformationMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.record.XMLTransformationRecord,XMLRecord>DatabaseException