Package org.eclipse.persistence.oxm
Class XMLDescriptor
- java.lang.Object
-
- org.eclipse.persistence.core.descriptors.CoreDescriptor<AttributeGroup,DescriptorEventManager,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,java.util.Vector,org.eclipse.persistence.internal.descriptors.ObjectBuilder>
-
- org.eclipse.persistence.descriptors.ClassDescriptor
-
- org.eclipse.persistence.oxm.XMLDescriptor
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,org.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
public class XMLDescriptor extends ClassDescriptor implements org.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
Use an XML project for nontransactional, nonpersistent (in-memory) conversions between Java objects and XML documents. An XMLDescriptor is a set of mappings that describe how an objects's data is to be represented in an XML document. XML descriptors describe Java objects that you map to simple and complex types defined by an XML schema document (XSD). Using XML descriptors in an EclipseLink XML project, you can configure XML mappings.
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.descriptors.ClassDescriptor
accessorTree, additionalAggregateCollectionKeyFields, additionalTablePrimaryKeyFields, additionalWritableMapKeyFields, AGGREGATE, AGGREGATE_COLLECTION, alias, allFields, allSelectionFields, amendmentClass, amendmentClassName, amendmentMethodName, cacheInvalidationPolicy, cachePolicy, cascadedLockingInitialized, cascadeLockingPolicies, changePolicy, cmpPolicy, constraintDependencies, copyPolicy, copyPolicyClassName, defaultDeleteObjectQueryRedirector, defaultDeleteObjectQueryRedirectorClassName, defaultInsertObjectQueryRedirector, defaultInsertObjectQueryRedirectorClassName, defaultQueryRedirector, defaultQueryRedirectorClassName, defaultReadAllQueryRedirector, defaultReadAllQueryRedirectorClassName, defaultReadObjectQueryRedirector, defaultReadObjectQueryRedirectorClassName, defaultReportQueryRedirector, defaultReportQueryRedirectorClassName, defaultTable, defaultUpdateObjectQueryRedirector, defaultUpdateObjectQueryRedirectorClassName, derivesIdMappings, descriptorCustomizerClassName, descriptorType, DO_NOT_SEND_CHANGES, ERROR, fetchGroupManager, fields, foreignKeyValuesForCaching, hasMultipleTableConstraintDependecy, hasNoncacheableMappings, hasRelationships, hasSimplePrimaryKey, historyPolicy, idValidation, initializationStage, INITIALIZED, INTERFACE, interfaceInitializationStage, interfacePolicy, INVALIDATE_CHANGED_OBJECTS, isCascadeOnDeleteSetOnDatabaseOnSecondaryTables, isNativeConnectionRequired, ISOLATE_CACHE_AFTER_TRANSACTION, ISOLATE_CACHE_ALWAYS, ISOLATE_FROM_CLIENT_SESSION, ISOLATE_NEW_DATA_AFTER_TRANSACTION, javaClass, javaClassName, lockableMappings, mappings, mappingsPostCalculateChanges, mappingsPostCalculateChangesOnDeleted, multipleTableForeignKeys, multipleTableInsertOrder, multitenantPolicy, NORMAL, optimisticLockingPolicy, partitioningPolicy, partitioningPolicyName, POST_INITIALIZED, preDeleteMappings, PREINITIALIZED, primaryKeyFields, primaryKeyIdValidations, properties, queryKeys, queryManager, referencingClasses, returnFieldsToGenerateInsert, returnFieldsToGenerateUpdate, returnFieldsToMergeInsert, returnFieldsToMergeUpdate, returningPolicies, returningPolicy, selectionFields, SEND_NEW_OBJECTS_WITH_CHANGES, SEND_OBJECT_CHANGES, sequence, sequenceNumberField, sequenceNumberName, serializedObjectPolicy, sessionName, shouldAcquireCascadedLocks, shouldAlwaysConformResultsInUnitOfWork, shouldBeReadOnly, shouldLockForClone, shouldOrderMappings, shouldRegisterResultsInUnitOfWork, shouldUseFullChangeSetsForNewObjects, tables, unconvertedProperties, UNDEFINED_ISOLATATION, UNDEFINED_OBJECT_CHANGE_BEHAVIOR, UNINITIALIZED, USE_SESSION_CACHE_AFTER_TRANSACTION, virtualAttributeMethods, weavingUsesPropertyAccess, wrapperPolicy
-
Fields inherited from class org.eclipse.persistence.core.descriptors.CoreDescriptor
attributeGroups, eventManager, field, inheritancePolicy, instantiationPolicy, objectBuilder
-
-
Constructor Summary
Constructors Constructor Description XMLDescriptor()PUBLIC: Return a new XMLDescriptor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DatabaseMappingaddDirectMapping(java.lang.String attributeName, java.lang.String xpathString)PUBLIC: Add a direct mapping to the receiver.DatabaseMappingaddDirectMapping(java.lang.String attributeName, java.lang.String getMethodName, java.lang.String setMethodName, java.lang.String xpathString)PUBLIC: Add a direct to node mapping to the receiver.voidaddPrimaryKeyField(org.eclipse.persistence.internal.helper.DatabaseField field)ADVANCED: Specify the primary key field of the descriptors table.voidaddPrimaryKeyFieldName(java.lang.String fieldName)PUBLIC: Specify the primary key field of the descriptors table.voidaddRootElement(java.lang.String rootElementName)PUBLIC: Add a root element name for the Descriptor This value is stored in place of a table namejava.util.VectorbuildDirectValuesFromFieldValue(java.lang.Object fieldValue)INTERNAL: Extract the direct values from the specified field value.org.eclipse.persistence.internal.helper.DatabaseFieldbuildField(java.lang.String fieldName)INTERNAL: A DatabaseField is built from the given field name.org.eclipse.persistence.internal.helper.DatabaseFieldbuildField(org.eclipse.persistence.internal.helper.DatabaseField field)INTERNAL: This is used only in initialization.java.lang.ObjectbuildFieldValueFromDirectValues(java.util.Vector directValues, java.lang.String elementDataTypeName, org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Build the appropriate field value for the specified set of direct values.java.lang.ObjectbuildFieldValueFromNestedRows(java.util.Vector nestedRows, java.lang.String structureName, org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Build and return the appropriate field value for the specified set of nested rows.org.eclipse.persistence.internal.sessions.AbstractRecordbuildNestedRowFromFieldValue(java.lang.Object fieldValue)INTERNAL: Build(if necessary) and return the nested XMLRecord from the specified field value.java.util.VectorbuildNestedRowsFromFieldValue(java.lang.Object fieldValue, org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Build(if necessary) and return a Vector of the nested XMLRecords from the specified field value.voidconvertClassNamesToClasses(java.lang.ClassLoader classLoader)INTERNAL: Convert all the class-name-based settings in this Descriptor to actual class-based settings.protected org.eclipse.persistence.internal.helper.DatabaseTableextractDefaultTable()Aggregates use a dummy table as default.java.lang.StringgetDefaultRootElement()PUBLIC: Return the default root element name for the ClassDescriptor This value is stored in place of a table name This value is mandatory for all root objectsXMLFieldgetDefaultRootElementField()javax.xml.namespace.QNamegetDefaultRootElementType()InheritancePolicygetInheritancePolicy()PUBLIC: The inheritance policy is used to define how a descriptor takes part in inheritance.AttributeAccessorgetLocationAccessor()INTERNAL: Returns this Descriptor's location accessor, if one is defined.NamespaceResolvergetNamespaceResolver()PUBLIC: Return the NamespaceResolver associated with this descriptorNamespaceResolvergetNonNullNamespaceResolver()java.util.Vector<java.lang.String>getPrimaryKeyFieldNames()PUBLIC: Return the names of all the primary keys.XMLSchemaReferencegetSchemaReference()PUBLIC: Return the SchemaReference associated with this descriptorprotected org.eclipse.persistence.internal.helper.DatabaseFieldgetTypedField(java.util.StringTokenizer stringTokenizer)org.eclipse.persistence.internal.helper.DatabaseFieldgetTypedField(org.eclipse.persistence.internal.helper.DatabaseField field)INTERNAL: searches first descriptor than its ReturningPolicy for an equal fieldbooleanhasReferenceMappings()INTERNAL: Returns true if any of the mappings on this descriptor are key-based reference mappings.voidinitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Initialize the mappings as a separate step.voidinitializeAggregateInheritancePolicy(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: This is needed by regular aggregate descriptors (because they require review); but not by XML aggregate descriptors.booleanisLazilyInitialized()If true, the descriptor may be lazily initialized.booleanisResultAlwaysXMLRoot()booleanisSequencedObject()INTERNAL:booleanisWrapper()booleanisXMLDescriptor()PUBLIC: Return if the descriptor maps to XML.DatabaseMappingnewAggregateCollectionMapping()Return a new aggregate collection/element collection mapping for this type of descriptor.AggregateMappingnewAggregateMapping()Return a new aggregate/embedded mapping for this type of descriptor.DatabaseMappingnewDirectCollectionMapping()Return a new direct collection/element collection mapping for this type of descriptor.AbstractDirectMappingnewDirectMapping()Return a new direct/basic mapping for this type of descriptor.voidpostInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Post initializations after mappings are initialized.voidpreInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Allow the descriptor to initialize any dependencies on this session.protected voidpreInitializeInheritancePolicy(org.eclipse.persistence.internal.sessions.AbstractSession session)Hook together the inheritance policy tree.booleanrequiresInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: XML descriptors are initialized normally, since they do not need to be cloned by XML aggregate mappings.voidsetDefaultRootElement(java.lang.String newDefaultRootElement)PUBLIC: Return the default root element name for the ClassDescriptor This value is stored in place of a table name This value is mandatory for all root objectsvoidsetDefaultRootElementField(XMLField xmlField)voidsetDefaultRootElementType(javax.xml.namespace.QName type)The default root element type string will be stored until initialization - a QName will be created and stored on the default root element field during initialize.voidsetIsWrapper(boolean value)voidsetLazilyInitialized(boolean shouldLazyInitiailize)Specify in the descriptor may be lazily initialized.voidsetLocationAccessor(AttributeAccessor value)INTERNAL: Set this Descriptor's location accessor.voidsetNamespaceResolver(NamespaceResolver newNamespaceResolver)PUBLIC: Set the NamespaceResolver to associate with this descriptorvoidsetPrimaryKeyFields(java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> thePrimaryKeyFields)INTERNAL: Set the primary key fieldsvoidsetResultAlwaysXMLRoot(boolean resultAlwaysXMLRoot)voidsetSchemaReference(XMLSchemaReference newSchemaReference)PUBLIC: Set the SchemaReference to associate with this descriptorvoidsetSequencedObject(boolean isSequenced)voidsetShouldPreserveDocument(boolean shouldPreserveDocument)PUBLIC: Specifies that object built from this descriptor should retain any unmapped information from their original XML Document when being written back out.voidsetTableNames(java.util.Vector tableNames)PUBLIC: Specify the all table names for the class of objects the receiver describes.voidsetTables(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseTable> theTables)INTERNAL: Sets the tablesbooleanshouldPreserveDocument()PUBLIC: Return if unmapped information from the XML document should be maintained for this descriptor By default unmapped data is not preserved.booleanshouldWrapObject(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, boolean isNamespaceAware)INTERNAL:protected voidvalidateMappingType(DatabaseMapping mapping)java.lang.ObjectwrapObjectInXMLRoot(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, boolean forceWrap, boolean isNamespaceAware, XMLUnmarshaller xmlUnmarshaller)INTERNAL: Determines the appropriate object to return from the unmarshal call.java.lang.ObjectwrapObjectInXMLRoot(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, java.lang.String encoding, java.lang.String version, boolean forceWrap, boolean isNamespaceAware, XMLUnmarshaller unmarshaller)INTERNAL:java.lang.ObjectwrapObjectInXMLRoot(org.eclipse.persistence.internal.oxm.record.UnmarshalRecord unmarshalRecord, boolean forceWrap)INTERNAL: Determines the appropriate object to return from the unmarshal call.-
Methods inherited from class org.eclipse.persistence.descriptors.ClassDescriptor
addAbstractQueryKey, addCascadeLockingPolicy, addConstraintDependencies, addConstraintDependency, addDirectQueryKey, addForeignKeyFieldForMultipleTable, addForeignKeyFieldNameForMultipleTable, addMapping, addMappingsPostCalculateChanges, addMappingsPostCalculateChangesOnDeleted, addPreDeleteMapping, addQueryKey, addTable, addTableName, addUnconvertedProperty, adjustMultipleTableInsertOrder, alwaysConformResultsInUnitOfWork, alwaysRefreshCache, alwaysRefreshCacheOnRemote, applyAmendmentMethod, applyAmendmentMethod, arePrimaryKeyFields, assignDefaultValues, buildBatchCriteriaByPK, buildCallFromStatement, buildField, buildFieldValueFromForeignKeys, buildFieldValueFromNestedRow, checkDatabase, checkInheritanceTreeAggregateSettings, clearReferencingClasses, clone, createCopyPolicy, createInstantiationPolicy, createMultipleTableInsertOrder, createMultipleTableInsertOrderFromComparison, createTableComparison, createTableOrder, descriptorIsAggregate, descriptorIsAggregateCollection, descriptorIsForInterface, descriptorIsNormal, disableCacheHits, disableCacheHitsOnRemote, dontAlwaysConformResultsInUnitOfWork, dontAlwaysRefreshCache, dontAlwaysRefreshCacheOnRemote, dontDisableCacheHits, dontDisableCacheHitsOnRemote, dontOnlyRefreshCacheIfNewerVersion, getAccessorTree, getAdditionalAggregateCollectionKeyFields, getAdditionalTablePrimaryKeyFields, getAdditionalWritableMapKeyFields, getAlias, getAllFields, getAllSelectionFields, getAllSelectionFields, getAmendmentClass, getAmendmentClassName, getAmendmentMethodName, getAttributeGroup, getAttributeGroups, getCacheInterceptorClass, getCacheInterceptorClassName, getCacheInvalidationPolicy, getCacheIsolation, getCacheKeyType, getCachePolicy, getCacheSynchronizationType, getCascadeLockingPolicies, getCMPPolicy, getConstraintDependencies, getCopyPolicy, getCopyPolicyClassName, getDefaultDeleteObjectQueryRedirector, getDefaultFetchGroup, getDefaultInsertObjectQueryRedirector, getDefaultQueryRedirector, getDefaultReadAllQueryRedirector, getDefaultReadObjectQueryRedirector, getDefaultReportQueryRedirector, getDefaultTable, getDefaultUpdateObjectQueryRedirector, getDerivesIdMappinps, getDescriptorCustomizerClassName, getDescriptorEventManager, getDescriptorInheritancePolicy, getDescriptorQueryManager, getDescriptorType, getDescriptorTypeValue, getEventManager, getFetchGroupManager, getFields, getForeignKeyValuesForCaching, getFullyMergeEntity, getHistoryPolicy, getIdentityMapClass, getIdentityMapSize, getIdValidation, getInheritancePolicyOrNull, getInstantiationPolicy, getInterfacePolicy, getInterfacePolicyOrNull, getJavaClass, getJavaClassName, getLockableMappings, getMappingForAttributeName, getMappings, getMappingsPostCalculateChanges, getMappingsPostCalculateChangesOnDeleted, getMultipleTableForeignKeyAssociations, getMultipleTableForeignKeys, getMultipleTableInsertOrder, getMultipleTablePrimaryKeyAssociations, getMultitenantPolicy, getObjectBuilder, getObjectChangePolicy, getObjectChangePolicyInternal, getOptimisticLockingPolicy, getPartitioningPolicy, getPartitioningPolicyName, getPreDeleteMappings, getPrimaryKeyFields, getPrimaryKeyIdValidations, getProperties, getProperty, getQueryKeyNamed, getQueryKeys, getQueryManager, getRemoteIdentityMapClass, getRemoteIdentityMapSize, getReturnFieldsToGenerateInsert, getReturnFieldsToGenerateUpdate, getReturnFieldsToMergeInsert, getReturnFieldsToMergeUpdate, getReturningPolicies, getReturningPolicy, getRootDescriptor, getSelectionFields, getSelectionFields, getSequence, getSequenceNumberField, getSequenceNumberFieldName, getSequenceNumberName, getSerializedObjectPolicy, getSessionName, getTable, getTableName, getTableNames, getTablePerClassPolicy, getTables, getUnconvertedProperties, getUnitOfWorkCacheIsolationLevel, getVirtualAttributeMethods, getWrapperPolicy, hasCascadeLockingPolicies, hasCMPPolicy, hasDependencyOnParts, hasDerivedId, hasEventManager, hasFetchGroupManager, hasInheritance, hasInterfacePolicy, hasMappingsPostCalculateChanges, hasMappingsPostCalculateChangesOnDeleted, hasMultipleTableConstraintDependecy, hasMultipleTables, hasMultitenantPolicy, hasNestedIdentityReference, hasNoncacheableMappings, hasPessimisticLockingPolicy, hasPreDeleteMappings, hasPrivatelyOwnedParts, hasQueryKeyOrMapping, hasRelationships, hasRelationshipsExceptBackpointer, hasReturningPolicies, hasReturningPolicy, hasSerializedObjectPolicy, hasSimplePrimaryKey, hasTablePerClassPolicy, hasTablePerMultitenantPolicy, hasTargetForeignKeyMapping, hasUnconvertedProperties, hasWrapperPolicy, initialize, initializeMultipleTablePrimaryKeyFields, initializeProperties, interfaceInitialization, isAbstract, isAggregateCollectionDescriptor, isAggregateDescriptor, isCascadeOnDeleteSetOnDatabaseOnSecondaryTables, isChildDescriptor, isDescriptorForInterface, isDescriptorTypeAggregate, isDescriptorTypeNormal, isEISDescriptor, isFullyInitialized, isInitialized, isInterfaceChildDescriptor, isInterfaceInitialized, isInvalid, isIsolated, isMultipleTableDescriptor, isNativeConnectionRequired, isObjectRelationalDataTypeDescriptor, isPrimaryKeySetAfterInsert, isProtectedIsolation, isRelationalDescriptor, isReturnTypeRequiredForReturningPolicy, isSharedIsolation, newManyToManyMapping, newManyToOneMapping, newOneToManyMapping, newOneToOneMapping, newUnidirectionalOneToManyMapping, notifyReferencingDescriptorsOfIsolation, onlyRefreshCacheIfNewerVersion, preInterfaceInitialization, prepareCascadeLockingPolicy, rehashFieldDependancies, reInitializeJoinedAttributes, remoteInitialization, removeMappingForAttributeName, removeProperty, selfValidationAfterInitialization, selfValidationBeforeInitialization, setAccessorTree, setAdditionalTablePrimaryKeyFields, setAdditionalTablePrimaryKeyFields, setAlias, setAllFields, setAmendmentClass, setAmendmentClassName, setAmendmentMethodName, setCacheable, setCacheInterceptorClass, setCacheInterceptorClassName, setCacheInvalidationPolicy, setCacheIsolation, setCacheKeyType, setCachePolicy, setCacheSynchronizationType, setCMPPolicy, setConstraintDependencies, setCopyPolicy, setCopyPolicyClassName, setDefaultDeleteObjectQueryRedirector, setDefaultDeleteObjectQueryRedirectorClassName, setDefaultInsertObjectQueryRedirector, setDefaultInsertObjectQueryRedirectorClassName, setDefaultQueryRedirector, setDefaultQueryRedirectorClassName, setDefaultReadAllQueryRedirector, setDefaultReadAllQueryRedirectorClassName, setDefaultReadObjectQueryRedirector, setDefaultReadObjectQueryRedirectorClassName, setDefaultReportQueryRedirector, setDefaultReportQueryRedirectorClassName, setDefaultTable, setDefaultTableName, setDefaultUpdateObjectQueryRedirector, setDefaultUpdateObjectQueryRedirectorClassName, setDescriptorCustomizerClassName, setDescriptorType, setDescriptorTypeValue, setEventManager, setExistenceChecking, setFetchGroupManager, setFields, setForeignKeyFieldNamesForMultipleTable, setFullyMergeEntity, setHasMultipleTableConstraintDependecy, setHasRelationships, setHasSimplePrimaryKey, setHistoryPolicy, setIdentityMapClass, setIdentityMapSize, setIdValidation, setInheritancePolicy, setInitializationStage, setInstantiationPolicy, setInterfaceInitializationStage, setInterfacePolicy, setInternalDefaultTable, setInternalDefaultTable, setIsCascadeOnDeleteSetOnDatabaseOnSecondaryTables, setIsIsolated, setIsNativeConnectionRequired, setJavaClass, setJavaClassName, setJavaInterface, setJavaInterfaceName, setLockableMappings, setMappings, setMultipleTableForeignKeys, setMultipleTableInsertOrder, setMultitenantPolicy, setObjectBuilder, setObjectChangePolicy, setOptimisticLockingPolicy, setPartitioningPolicy, setPartitioningPolicyName, setPrimaryKeyFieldName, setPrimaryKeyFieldNames, setPrimaryKeyIdValidations, setProperties, setProperty, setQueryKeys, setQueryManager, setReadOnly, setRemoteIdentityMapClass, setRemoteIdentityMapSize, setReturningPolicy, setSequence, setSequenceNumberField, setSequenceNumberFieldName, setSequenceNumberName, setSerializedObjectPolicy, setSessionName, setShouldAcquireCascadedLocks, setShouldAlwaysConformResultsInUnitOfWork, setShouldAlwaysRefreshCache, setShouldAlwaysRefreshCacheOnRemote, setShouldBeReadOnly, setShouldDisableCacheHits, setShouldDisableCacheHitsOnRemote, setShouldLockForClone, setShouldOnlyRefreshCacheIfNewerVersion, setShouldOrderMappings, setShouldRegisterResultsInUnitOfWork, setTableName, setTablePerClassPolicy, setTableQualifier, setUnitOfWorkCacheIsolationLevel, setVirtualAttributeMethods, setWrapperPolicy, shouldAcquireCascadedLocks, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldAlwaysRefreshCacheOnRemote, shouldBeReadOnly, shouldDisableCacheHits, shouldDisableCacheHitsOnRemote, shouldIsolateObjectsInUnitOfWork, shouldIsolateObjectsInUnitOfWorkEarlyTransaction, shouldIsolateProtectedObjectsInUnitOfWork, shouldLockForClone, shouldOnlyRefreshCacheIfNewerVersion, shouldOrderMappings, shouldRegisterResultsInUnitOfWork, shouldUseAdditionalJoinExpression, shouldUseCacheIdentityMap, shouldUseFullChangeSetsForNewObjects, shouldUseFullIdentityMap, shouldUseHardCacheWeakIdentityMap, shouldUseNoIdentityMap, shouldUseRemoteCacheIdentityMap, shouldUseRemoteFullIdentityMap, shouldUseRemoteHardCacheWeakIdentityMap, shouldUseRemoteNoIdentityMap, shouldUseRemoteSoftCacheWeakIdentityMap, shouldUseRemoteSoftIdentityMap, shouldUseRemoteWeakIdentityMap, shouldUseSessionCacheInUnitOfWorkEarlyTransaction, shouldUseSoftCacheWeakIdentityMap, shouldUseSoftIdentityMap, shouldUseWeakIdentityMap, supportsChangeTracking, toggleAdditionalTablePrimaryKeyFields, toString, useAllFieldsLocking, useCacheIdentityMap, useChangedFieldsLocking, useCloneCopyPolicy, useCloneCopyPolicy, useDefaultConstructorInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFullIdentityMap, useHardCacheWeakIdentityMap, useInstantiationCopyPolicy, useMethodInstantiationPolicy, useNoIdentityMap, usePropertyAccessForWeaving, useRemoteCacheIdentityMap, useRemoteFullIdentityMap, useRemoteHardCacheWeakIdentityMap, useRemoteNoIdentityMap, useRemoteSoftCacheWeakIdentityMap, useRemoteSoftIdentityMap, useRemoteWeakIdentityMap, useSelectedFieldsLocking, usesFieldLocking, useSoftCacheWeakIdentityMap, useSoftIdentityMap, usesOptimisticLocking, usesPropertyAccessForWeaving, usesSequenceNumbers, usesVersionLocking, useTimestampLocking, useTimestampLocking, useVersionLocking, useVersionLocking, useWeakIdentityMap, validateAfterInitialization, validateBeforeInitialization, verifyMultipleTableInsertOrder, verifyMultipleTablesForeignKeysTables, verifyTableQualifiers
-
Methods inherited from class org.eclipse.persistence.core.descriptors.CoreDescriptor
addAttributeGroup
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Descriptor
addMapping, getAlias, getAttributeGroup, getInheritancePolicyOrNull, getInstantiationPolicy, getJavaClass, getJavaClassName, getMappingForAttributeName, getMappings, getObjectBuilder, getPrimaryKeyFields, getTableNames, getTables, hasInheritance, setInstantiationPolicy, setJavaClass, setJavaClassName, setProperties
-
-
-
-
Method Detail
-
getDefaultRootElement
public java.lang.String getDefaultRootElement()
PUBLIC: Return the default root element name for the ClassDescriptor This value is stored in place of a table name This value is mandatory for all root objects- Specified by:
getDefaultRootElementin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Returns:
- the default root element specified on this ClassDescriptor
-
shouldPreserveDocument
public boolean shouldPreserveDocument()
PUBLIC: Return if unmapped information from the XML document should be maintained for this descriptor By default unmapped data is not preserved.- Specified by:
shouldPreserveDocumentin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Returns:
- if this descriptor should preserve unmapped data
-
setShouldPreserveDocument
public void setShouldPreserveDocument(boolean shouldPreserveDocument)
PUBLIC: Specifies that object built from this descriptor should retain any unmapped information from their original XML Document when being written back out. By default unmapped data is not preserved.- Parameters:
shouldPreserveDocument- if this descriptor should preserve unmapped data
-
addRootElement
public void addRootElement(java.lang.String rootElementName)
PUBLIC: Add a root element name for the Descriptor This value is stored in place of a table name- Specified by:
addRootElementin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
rootElementName- a root element to specify on this Descriptor
-
setDefaultRootElement
public void setDefaultRootElement(java.lang.String newDefaultRootElement)
PUBLIC: Return the default root element name for the ClassDescriptor This value is stored in place of a table name This value is mandatory for all root objects- Specified by:
setDefaultRootElementin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
newDefaultRootElement- the default root element to specify on this ClassDescriptor
-
getNamespaceResolver
public NamespaceResolver getNamespaceResolver()
PUBLIC: Return the NamespaceResolver associated with this descriptor- Specified by:
getNamespaceResolverin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Returns:
- the NamespaceResolver associated with this descriptor
- See Also:
NamespaceResolver
-
getNonNullNamespaceResolver
public NamespaceResolver getNonNullNamespaceResolver()
- Specified by:
getNonNullNamespaceResolverin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
getInheritancePolicy
public InheritancePolicy getInheritancePolicy()
PUBLIC: The inheritance policy is used to define how a descriptor takes part in inheritance. All inheritance properties for both child and parent classes is configured in inheritance policy. Caution must be used in using this method as it lazy initializes an inheritance policy. Calling this on a descriptor that does not use inheritance will cause problems, #hasInheritance() must always first be called.- Specified by:
getInheritancePolicyin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Overrides:
getInheritancePolicyin classClassDescriptor- Returns:
- the InheritancePolicy associated with this descriptor
-
setNamespaceResolver
public void setNamespaceResolver(NamespaceResolver newNamespaceResolver)
PUBLIC: Set the NamespaceResolver to associate with this descriptor- Specified by:
setNamespaceResolverin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
newNamespaceResolver- the NamespaceResolver to associate with this descriptor- See Also:
NamespaceResolver
-
getSchemaReference
public XMLSchemaReference getSchemaReference()
PUBLIC: Return the SchemaReference associated with this descriptor- Specified by:
getSchemaReferencein interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Returns:
- the SchemaReference associated with this descriptor
- See Also:
org.eclipse.persistence.oxm.schema
-
setSchemaReference
public void setSchemaReference(XMLSchemaReference newSchemaReference)
PUBLIC: Set the SchemaReference to associate with this descriptor- Specified by:
setSchemaReferencein interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
newSchemaReference- the SchemaReference to associate with this descriptor- See Also:
org.eclipse.persistence.oxm.schema
-
isXMLDescriptor
public boolean isXMLDescriptor()
PUBLIC: Return if the descriptor maps to XML.- Overrides:
isXMLDescriptorin classClassDescriptor
-
isLazilyInitialized
public boolean isLazilyInitialized()
If true, the descriptor may be lazily initialized. This is useful if the descriptor may not get used.- Specified by:
isLazilyInitializedin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setLazilyInitialized
public void setLazilyInitialized(boolean shouldLazyInitiailize)
Specify in the descriptor may be lazily initialized. The default is false.
-
getPrimaryKeyFieldNames
public java.util.Vector<java.lang.String> getPrimaryKeyFieldNames()
Description copied from class:ClassDescriptorPUBLIC: Return the names of all the primary keys.- Specified by:
getPrimaryKeyFieldNamesin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Overrides:
getPrimaryKeyFieldNamesin classClassDescriptor
-
validateMappingType
protected void validateMappingType(DatabaseMapping mapping)
- Overrides:
validateMappingTypein classClassDescriptor
-
buildNestedRowFromFieldValue
public org.eclipse.persistence.internal.sessions.AbstractRecord buildNestedRowFromFieldValue(java.lang.Object fieldValue)
INTERNAL: Build(if necessary) and return the nested XMLRecord from the specified field value. The field value should be an XMLRecord or and XMLElement- Overrides:
buildNestedRowFromFieldValuein classClassDescriptor
-
buildNestedRowsFromFieldValue
public java.util.Vector buildNestedRowsFromFieldValue(java.lang.Object fieldValue, org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Build(if necessary) and return a Vector of the nested XMLRecords from the specified field value. The field value should be a Vector, an XMLRecord, or an XMLElement- Overrides:
buildNestedRowsFromFieldValuein classClassDescriptor
-
newDirectMapping
public AbstractDirectMapping newDirectMapping()
Return a new direct/basic mapping for this type of descriptor.- Overrides:
newDirectMappingin classClassDescriptor
-
newAggregateMapping
public AggregateMapping newAggregateMapping()
Return a new aggregate/embedded mapping for this type of descriptor.- Overrides:
newAggregateMappingin classClassDescriptor
-
newAggregateCollectionMapping
public DatabaseMapping newAggregateCollectionMapping()
Return a new aggregate collection/element collection mapping for this type of descriptor.- Overrides:
newAggregateCollectionMappingin classClassDescriptor
-
newDirectCollectionMapping
public DatabaseMapping newDirectCollectionMapping()
Return a new direct collection/element collection mapping for this type of descriptor.- Overrides:
newDirectCollectionMappingin classClassDescriptor
-
addDirectMapping
public DatabaseMapping addDirectMapping(java.lang.String attributeName, java.lang.String xpathString)
PUBLIC: Add a direct mapping to the receiver. The new mapping specifies that an instance variable of the class of objects which the receiver describes maps in the default manner for its type to the indicated database field.- Overrides:
addDirectMappingin classClassDescriptor- Parameters:
attributeName- the name of an instance variable of the class which the receiver describes.xpathString- the xpath of the xml element or attribute which corresponds with the designated instance variable.- Returns:
- The newly created DatabaseMapping is returned.
-
addDirectMapping
public DatabaseMapping addDirectMapping(java.lang.String attributeName, java.lang.String getMethodName, java.lang.String setMethodName, java.lang.String xpathString)
PUBLIC: Add a direct to node mapping to the receiver. The new mapping specifies that a variable accessed by the get and set methods of the class of objects which the receiver describes maps in the default manner for its type to the indicated database field.- Overrides:
addDirectMappingin classClassDescriptor
-
addPrimaryKeyFieldName
public void addPrimaryKeyFieldName(java.lang.String fieldName)
Description copied from class:ClassDescriptorPUBLIC: Specify the primary key field of the descriptors table. This should be called for each field that makes up the primary key of the table. If the descriptor has many tables, this must be the primary key in the first table, if the other tables have the same primary key nothing else is required, otherwise a primary key/foreign key field mapping must be provided for each of the other tables.- Overrides:
addPrimaryKeyFieldNamein classClassDescriptor- See Also:
ClassDescriptor.addForeignKeyFieldNameForMultipleTable(String, String)
-
addPrimaryKeyField
public void addPrimaryKeyField(org.eclipse.persistence.internal.helper.DatabaseField field)
Description copied from class:ClassDescriptorADVANCED: Specify the primary key field of the descriptors table. This should be called for each field that makes up the primary key of the table. This can be used for advanced field types, such as XML nodes, or to set the field type.- Specified by:
addPrimaryKeyFieldin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Overrides:
addPrimaryKeyFieldin classClassDescriptor
-
setPrimaryKeyFields
public void setPrimaryKeyFields(java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> thePrimaryKeyFields)
Description copied from class:ClassDescriptorINTERNAL: Set the primary key fields- Overrides:
setPrimaryKeyFieldsin classClassDescriptor- See Also:
ClassDescriptor.addPrimaryKeyFieldName(String)
-
buildDirectValuesFromFieldValue
public java.util.Vector buildDirectValuesFromFieldValue(java.lang.Object fieldValue) throws DatabaseExceptionINTERNAL: Extract the direct values from the specified field value. Return them in a vector. The field value could be a vector or could be a text value if only a single value.- Overrides:
buildDirectValuesFromFieldValuein classClassDescriptor- Throws:
DatabaseException
-
buildFieldValueFromDirectValues
public java.lang.Object buildFieldValueFromDirectValues(java.util.Vector directValues, java.lang.String elementDataTypeName, org.eclipse.persistence.internal.sessions.AbstractSession session) throws DatabaseExceptionINTERNAL: Build the appropriate field value for the specified set of direct values. The database better be expecting a Vector.- Overrides:
buildFieldValueFromDirectValuesin classClassDescriptor- Throws:
DatabaseException
-
buildFieldValueFromNestedRows
public java.lang.Object buildFieldValueFromNestedRows(java.util.Vector nestedRows, java.lang.String structureName, org.eclipse.persistence.internal.sessions.AbstractSession session) throws DatabaseExceptionINTERNAL: Build and return the appropriate field value for the specified set of nested rows.- Overrides:
buildFieldValueFromNestedRowsin classClassDescriptor- Throws:
DatabaseException
-
buildField
public org.eclipse.persistence.internal.helper.DatabaseField buildField(java.lang.String fieldName)
INTERNAL: A DatabaseField is built from the given field name.- Overrides:
buildFieldin classClassDescriptor
-
buildField
public org.eclipse.persistence.internal.helper.DatabaseField buildField(org.eclipse.persistence.internal.helper.DatabaseField field)
INTERNAL: This is used only in initialization.- Overrides:
buildFieldin classClassDescriptor
-
initializeAggregateInheritancePolicy
public void initializeAggregateInheritancePolicy(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: This is needed by regular aggregate descriptors (because they require review); but not by XML aggregate descriptors.- Overrides:
initializeAggregateInheritancePolicyin classClassDescriptor
-
setTableNames
public void setTableNames(java.util.Vector tableNames)
Description copied from class:ClassDescriptorPUBLIC: Specify the all table names for the class of objects the receiver describes. If the table has a qualifier it should be specified using the dot notation, (i.e. "userid.employee"). This method is used for multiple tables- Overrides:
setTableNamesin classClassDescriptor
-
setTables
public void setTables(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseTable> theTables)
INTERNAL: Sets the tables- Overrides:
setTablesin classClassDescriptor
-
preInitialize
public void preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorExceptionINTERNAL: Allow the descriptor to initialize any dependencies on this session.- Overrides:
preInitializein classClassDescriptor- Throws:
DescriptorException
-
preInitializeInheritancePolicy
protected void preInitializeInheritancePolicy(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorExceptionDescription copied from class:ClassDescriptorHook together the inheritance policy tree.- Overrides:
preInitializeInheritancePolicyin classClassDescriptor- Throws:
DescriptorException
-
postInitialize
public void postInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorExceptionINTERNAL: Post initializations after mappings are initialized.- Overrides:
postInitializein classClassDescriptor- Throws:
DescriptorException
-
initialize
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorExceptionINTERNAL: Initialize the mappings as a separate step. This is done as a separate step to ensure that inheritance has been first resolved.- Overrides:
initializein classClassDescriptor- Throws:
DescriptorException
-
requiresInitialization
public boolean requiresInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: XML descriptors are initialized normally, since they do not need to be cloned by XML aggregate mappings.- Overrides:
requiresInitializationin classClassDescriptor
-
extractDefaultTable
protected org.eclipse.persistence.internal.helper.DatabaseTable extractDefaultTable()
Aggregates use a dummy table as default.- Overrides:
extractDefaultTablein classClassDescriptor
-
wrapObjectInXMLRoot
public java.lang.Object wrapObjectInXMLRoot(org.eclipse.persistence.internal.oxm.record.UnmarshalRecord unmarshalRecord, boolean forceWrap)INTERNAL: Determines the appropriate object to return from the unmarshal call. The method will either return the object created in the xmlReader.parse() call or an instance of Root. An Root instance will be returned if the DOMRecord element being unmarshalled does not equal the descriptor's default root element.- Specified by:
wrapObjectInXMLRootin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
unmarshalRecord-- Returns:
- object
-
wrapObjectInXMLRoot
public java.lang.Object wrapObjectInXMLRoot(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, boolean forceWrap, boolean isNamespaceAware, XMLUnmarshaller xmlUnmarshaller)INTERNAL: Determines the appropriate object to return from the unmarshal call. The method will either return the object created in the xmlReader.parse() call or an instance of Root. An Root instance will be returned if the DOMRecord element being unmarshalled does not equal the descriptor's default root element.- Specified by:
wrapObjectInXMLRootin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Parameters:
object-elementNamespaceUri-elementLocalName-elementPrefix-- Returns:
- object
-
wrapObjectInXMLRoot
public java.lang.Object wrapObjectInXMLRoot(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, java.lang.String encoding, java.lang.String version, boolean forceWrap, boolean isNamespaceAware, XMLUnmarshaller unmarshaller)INTERNAL:- Specified by:
wrapObjectInXMLRootin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Returns:
-
shouldWrapObject
public boolean shouldWrapObject(java.lang.Object object, java.lang.String elementNamespaceUri, java.lang.String elementLocalName, java.lang.String elementPrefix, boolean isNamespaceAware)INTERNAL:- Returns:
-
getDefaultRootElementField
public XMLField getDefaultRootElementField()
- Specified by:
getDefaultRootElementFieldin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setDefaultRootElementField
public void setDefaultRootElementField(XMLField xmlField)
-
getDefaultRootElementType
public javax.xml.namespace.QName getDefaultRootElementType()
- Specified by:
getDefaultRootElementTypein interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setDefaultRootElementType
public void setDefaultRootElementType(javax.xml.namespace.QName type)
The default root element type string will be stored until initialization - a QName will be created and stored on the default root element field during initialize.- Parameters:
type-
-
isSequencedObject
public boolean isSequencedObject()
INTERNAL:Indicates if the Object mapped by this descriptor is a sequenced data object and should be marshalled accordingly.
- Specified by:
isSequencedObjectin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setSequencedObject
public void setSequencedObject(boolean isSequenced)
-
isWrapper
public boolean isWrapper()
- Specified by:
isWrapperin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setIsWrapper
public void setIsWrapper(boolean value)
-
isResultAlwaysXMLRoot
public boolean isResultAlwaysXMLRoot()
- Specified by:
isResultAlwaysXMLRootin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setResultAlwaysXMLRoot
public void setResultAlwaysXMLRoot(boolean resultAlwaysXMLRoot)
- Specified by:
setResultAlwaysXMLRootin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
hasReferenceMappings
public boolean hasReferenceMappings()
INTERNAL: Returns true if any of the mappings on this descriptor are key-based reference mappings.
-
getTypedField
public org.eclipse.persistence.internal.helper.DatabaseField getTypedField(org.eclipse.persistence.internal.helper.DatabaseField field)
Description copied from class:ClassDescriptorINTERNAL: searches first descriptor than its ReturningPolicy for an equal field- Specified by:
getTypedFieldin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>- Overrides:
getTypedFieldin classClassDescriptor
-
getTypedField
protected org.eclipse.persistence.internal.helper.DatabaseField getTypedField(java.util.StringTokenizer stringTokenizer)
-
getLocationAccessor
public AttributeAccessor getLocationAccessor()
INTERNAL: Returns this Descriptor's location accessor, if one is defined.- Specified by:
getLocationAccessorin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
setLocationAccessor
public void setLocationAccessor(AttributeAccessor value)
INTERNAL: Set this Descriptor's location accessor.- Specified by:
setLocationAccessorin interfaceorg.eclipse.persistence.internal.oxm.mappings.Descriptor<AttributeAccessor,DatabaseMapping,org.eclipse.persistence.internal.helper.DatabaseField,InheritancePolicy,org.eclipse.persistence.internal.descriptors.InstantiationPolicy,NamespaceResolver,org.eclipse.persistence.internal.descriptors.ObjectBuilder,org.eclipse.persistence.internal.helper.DatabaseTable,org.eclipse.persistence.internal.oxm.record.UnmarshalRecord,XMLUnmarshaller>
-
convertClassNamesToClasses
public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
INTERNAL: Convert all the class-name-based settings in this Descriptor to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.- Overrides:
convertClassNamesToClassesin classClassDescriptor- Parameters:
classLoader-
-
-