public class XMLObjectBuilder extends ObjectBuilder
Purpose: Object-to-XML specific ObjectBuilder.
Constructor and Description |
---|
XMLObjectBuilder(ClassDescriptor descriptor)
Create an XML object builder for the descriptor.
|
Modifier and Type | Method and Description |
---|---|
void |
addNamespaceDeclarations(org.w3c.dom.Document document) |
boolean |
addXsiTypeAndClassIndicatorIfRequired(XMLRecord record,
XMLDescriptor xmlDescriptor,
XMLDescriptor referenceDescriptor,
XMLField xmlField,
boolean isRootElement) |
boolean |
addXsiTypeAndClassIndicatorIfRequired(XMLRecord record,
XMLDescriptor xmlDescriptor,
XMLDescriptor referenceDescriptor,
XMLField xmlField,
java.lang.Object originalObject,
java.lang.Object obj,
boolean wasXMLRoot,
boolean isRootElement) |
void |
buildAttributesIntoObject(java.lang.Object domainObject,
CacheKey cacheKey,
AbstractRecord databaseRow,
ObjectBuildingQuery query,
JoinedAttributeManager joinManager,
boolean forRefresh,
AbstractSession targetSession)
Override method in superclass in order to set the session on the record.
|
AbstractRecord |
buildIntoNestedRow(AbstractRecord row,
java.lang.Object object,
AbstractSession session) |
AbstractRecord |
buildIntoNestedRow(AbstractRecord row,
java.lang.Object object,
AbstractSession session,
XMLDescriptor refDesc,
XMLField xmlField) |
AbstractRecord |
buildIntoNestedRow(AbstractRecord row,
java.lang.Object originalObject,
java.lang.Object object,
AbstractSession session,
XMLDescriptor refDesc,
XMLField xmlField,
boolean wasXMLRoot) |
java.lang.Object |
buildObject(ObjectBuildingQuery query,
AbstractRecord databaseRow,
JoinedAttributeManager joinManager)
INTERNAL: Override the parent's buildObject to allow for the caching of
aggregate objects in OX.
|
AbstractRecord |
buildRow(AbstractRecord databaseRow,
java.lang.Object object,
AbstractSession session) |
AbstractRecord |
buildRow(AbstractRecord databaseRow,
java.lang.Object object,
AbstractSession session,
boolean wasXMLRoot) |
AbstractRecord |
buildRow(java.lang.Object object,
AbstractSession session,
DatabaseField xmlField,
XMLRecord parentRecord)
Build the nested row into the parent dom.
|
AbstractRecord |
createRecord(AbstractSession session)
Create a new row/record for the object builder.
|
AbstractRecord |
createRecord(int size,
AbstractSession session)
Create a new row/record for the object builder.
|
AbstractRecord |
createRecord(java.lang.String rootName,
AbstractSession session)
Create a new row/record for the object builder with the given name.
|
AbstractRecord |
createRecord(java.lang.String rootName,
org.w3c.dom.Node parent,
AbstractSession session)
Create a new row/record for the object builder with the given name.
|
AbstractRecord |
createRecord(java.lang.String rootName,
java.lang.String rootUri,
AbstractSession session)
Create a new row/record for the object builder with the given name and
namespace resolver instead of the namespace resolver from the descriptor.
|
AbstractRecord |
createRecordFor(java.lang.Object object,
DocumentPreservationPolicy docPresPolicy) |
AbstractRecord |
createRecordFor(java.lang.Object object,
DocumentPreservationPolicy docPresPolicy,
java.lang.String rootName,
java.lang.String rootUri) |
AbstractRecord |
createRecordFor(java.lang.Object attributeValue,
XMLField xmlField,
XMLRecord parentRecord,
XMLMapping mapping) |
java.lang.Object |
extractPrimaryKeyFromExpression(boolean requiresExactMatch,
Expression expression,
AbstractRecord translationRow,
AbstractSession session)
Override method in superclass in order to set the session on the record.
|
java.lang.Object |
extractPrimaryKeyFromObject(java.lang.Object domainObject,
AbstractSession session)
Extract primary key attribute values from the domainObject.
|
AbstractRecord |
extractPrimaryKeyRowFromExpression(Expression expression,
AbstractRecord translationRow,
AbstractSession session)
Override method in superclass in order to set the session on the record.
|
NamespaceResolver |
getNamespaceResolver() |
void |
initialize(AbstractSession session)
Cache all the mappings by their attribute and fields.
|
boolean |
isXMLObjectBuilder() |
void |
removeExtraNamespacesFromNamespaceResolver(XMLRecord marshalRecord,
java.util.List extraNamespaces,
AbstractSession session) |
void |
setDescriptor(ClassDescriptor aDescriptor)
Set the descriptor.
|
void |
writeExtraNamespaces(java.util.List extraNamespaces,
XMLRecord xmlRecord) |
void |
writeOutMappings(XMLRecord row,
java.lang.Object object,
AbstractSession session) |
addPrimaryKeyForNonDefaultTable, addPrimaryKeyForNonDefaultTable, assignReturnRow, assignReturnValueForField, assignSequenceNumber, assignSequenceNumber, buildAttributesIntoShallowObject, buildAttributesIntoWorkingCopyClone, buildBackupClone, buildDeleteExpression, buildExpressionFromExample, buildNewInstance, buildObject, buildObjectFromResultSet, buildObjectsInto, buildPrimaryKeyAttributesIntoObject, buildPrimaryKeyExpression, buildPrimaryKeyExpressionFromKeys, buildPrimaryKeyExpressionFromObject, buildRow, buildRow, buildRowForShallowInsert, buildRowForShallowInsert, buildRowForTranslation, buildRowForUpdate, buildRowForUpdate, buildRowForUpdateAfterShallowInsert, buildRowForUpdateAfterShallowInsert, buildRowForUpdateBeforeShallowDelete, buildRowForUpdateBeforeShallowDelete, buildRowForUpdateWithChangeSet, buildRowForWhereClause, buildRowFromPrimaryKeyValues, buildRowWithChangeSet, buildTemplateInsertRow, buildTemplateInsertRow, buildTemplateUpdateRow, buildUpdateExpression, cacheForeignKeyValues, cacheForeignKeyValues, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemove, cascadePerformRemovePrivateOwnedObjectFromChangeSet, cascadeRegisterNewForCreate, clearPrimaryKey, clone, compareForChange, compareObjects, copyInto, copyInto, copyObject, createObjectChangeSet, createObjectChangeSet, createObjectChangeSet, createPrimaryKeyExpression, extractPrimaryKeyFromObject, extractPrimaryKeyFromRow, extractPrimaryKeyRowFromObject, extractRowFromExpression, extractValueFromObjectForField, fixObjectReferences, getBaseChangeRecordForField, getBaseMappingForField, getBaseValueForField, getBatchFetchedAttributes, getCloningMappings, getDescriptor, getEagerMappings, getFieldClassification, getFieldForQueryKeyName, getFieldsMap, getJoinedAttributes, getLockAttribute, getMappingForAttributeName, getMappingForField, getMappingsByField, getParentObjectForField, getPrimaryKeyClassifications, getPrimaryKeyExpression, getPrimaryKeyMappings, getReadOnlyMappingsByField, getReadOnlyMappingsForField, getRelationshipMappings, getSequenceMapping, getTargetFieldForQueryKeyName, hasBatchFetchedAttributes, hasInBatchFetchedAttribute, hasJoinedAttributes, hasWrapperPolicy, initializeBatchFetchedAttributes, initializeJoinedAttributes, initializePrimaryKey, instantiateClone, instantiateEagerMappings, instantiateWorkingCopyClone, instantiateWorkingCopyCloneFromRow, isPrimaryKeyComponentInvalid, isPrimaryKeyExpression, isPrimaryKeyMapping, isSimple, iterate, mergeChangesIntoObject, mergeChangesIntoObject, mergeIntoObject, mergeIntoObject, populateAttributesForClone, postInitialize, recordPrivateOwnedRemovals, rehashFieldDependancies, setHasInBatchFetchedAttribute, setHasWrapperPolicy, setMappingsByField, setPrimaryKeyClassifications, setPrimaryKeyExpression, setReadOnlyMappingsByField, setSequenceMapping, toString, trimFieldsForInsert, unwrapObject, updateCachedAttributes, validate, verifyDelete, wrapObject, writeIntoRowFromPrimaryKeyValues
public XMLObjectBuilder(ClassDescriptor descriptor)
public AbstractRecord buildRow(java.lang.Object object, AbstractSession session, DatabaseField xmlField, XMLRecord parentRecord)
public AbstractRecord createRecord(AbstractSession session)
createRecord
in class ObjectBuilder
public AbstractRecord createRecord(int size, AbstractSession session)
createRecord
in class ObjectBuilder
public AbstractRecord createRecord(java.lang.String rootName, AbstractSession session)
public AbstractRecord createRecord(java.lang.String rootName, java.lang.String rootUri, AbstractSession session)
public AbstractRecord createRecord(java.lang.String rootName, org.w3c.dom.Node parent, AbstractSession session)
public AbstractRecord createRecordFor(java.lang.Object attributeValue, XMLField xmlField, XMLRecord parentRecord, XMLMapping mapping)
public AbstractRecord createRecordFor(java.lang.Object object, DocumentPreservationPolicy docPresPolicy)
public AbstractRecord createRecordFor(java.lang.Object object, DocumentPreservationPolicy docPresPolicy, java.lang.String rootName, java.lang.String rootUri)
public java.lang.Object buildObject(ObjectBuildingQuery query, AbstractRecord databaseRow, JoinedAttributeManager joinManager) throws DatabaseException, QueryException
buildObject
in class ObjectBuilder
DatabaseException
QueryException
public AbstractRecord buildRow(AbstractRecord databaseRow, java.lang.Object object, AbstractSession session)
public AbstractRecord buildRow(AbstractRecord databaseRow, java.lang.Object object, AbstractSession session, boolean wasXMLRoot)
public void writeOutMappings(XMLRecord row, java.lang.Object object, AbstractSession session)
public void addNamespaceDeclarations(org.w3c.dom.Document document)
public void buildAttributesIntoObject(java.lang.Object domainObject, CacheKey cacheKey, AbstractRecord databaseRow, ObjectBuildingQuery query, JoinedAttributeManager joinManager, boolean forRefresh, AbstractSession targetSession) throws DatabaseException
buildAttributesIntoObject
in class ObjectBuilder
DatabaseException
public AbstractRecord extractPrimaryKeyRowFromExpression(Expression expression, AbstractRecord translationRow, AbstractSession session)
extractPrimaryKeyRowFromExpression
in class ObjectBuilder
public java.lang.Object extractPrimaryKeyFromExpression(boolean requiresExactMatch, Expression expression, AbstractRecord translationRow, AbstractSession session)
extractPrimaryKeyFromExpression
in class ObjectBuilder
public java.lang.Object extractPrimaryKeyFromObject(java.lang.Object domainObject, AbstractSession session)
ObjectBuilder
extractPrimaryKeyFromObject
in class ObjectBuilder
public AbstractRecord buildIntoNestedRow(AbstractRecord row, java.lang.Object object, AbstractSession session)
public AbstractRecord buildIntoNestedRow(AbstractRecord row, java.lang.Object object, AbstractSession session, XMLDescriptor refDesc, XMLField xmlField)
public AbstractRecord buildIntoNestedRow(AbstractRecord row, java.lang.Object originalObject, java.lang.Object object, AbstractSession session, XMLDescriptor refDesc, XMLField xmlField, boolean wasXMLRoot)
public NamespaceResolver getNamespaceResolver()
public void setDescriptor(ClassDescriptor aDescriptor)
setDescriptor
in class ObjectBuilder
public void writeExtraNamespaces(java.util.List extraNamespaces, XMLRecord xmlRecord)
public void removeExtraNamespacesFromNamespaceResolver(XMLRecord marshalRecord, java.util.List extraNamespaces, AbstractSession session)
public void initialize(AbstractSession session) throws DescriptorException
ObjectBuilder
initialize
in class ObjectBuilder
DescriptorException
public boolean isXMLObjectBuilder()
isXMLObjectBuilder
in class ObjectBuilder
public boolean addXsiTypeAndClassIndicatorIfRequired(XMLRecord record, XMLDescriptor xmlDescriptor, XMLDescriptor referenceDescriptor, XMLField xmlField, java.lang.Object originalObject, java.lang.Object obj, boolean wasXMLRoot, boolean isRootElement)
record
- The XMLRecord to write toxmlDescriptor
- The Descriptor of the object we are writingreferenceDescriptor
- The known descriptor for this mapping (if it exisits)xmlField
- originalObject
- Could be an XMLRoot otherwise the same as objobj
- The object being marshalledwasXMLRoot
- boolean if the originalObject was an XMLRootaddToNamespaceResolver
- boolean if we should add generated namespaces to the NamespaceResolverpublic boolean addXsiTypeAndClassIndicatorIfRequired(XMLRecord record, XMLDescriptor xmlDescriptor, XMLDescriptor referenceDescriptor, XMLField xmlField, boolean isRootElement)
EclipseLink 2.4.2, "build v20130514-5956486" API Reference