oracle.toplink.xml
Class XMLDescriptor

java.lang.Object
oracle.toplink.publicinterface.Descriptor
oracle.toplink.sdk.SDKDescriptor
oracle.toplink.xml.XMLDescriptor

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class XMLDescriptor

extends SDKDescriptor

XMLDescriptor extends the SDKDescriptor protocol with a number of defaults and helper methods that simplify the use of XML data store.

Since:

TOPLink/Java 3.0

See Also:

XMLCall, Serialized Form

Constructor Summary

XMLDescriptor()
PUBLIC: Default constructor.

Method Summary

void	addPrimaryKeyElementName(java.lang.String elementName) PUBLIC: Add a primary key element for the descriptor.
java.util.Vector	getPrimaryKeyElementNames() PUBLIC: Return the names of all the primary key elements.
java.lang.String	getRootElementName() PUBLIC: Return the root element name for the class of objects the descriptor maps.
java.lang.String	getSequenceNumberElementName() PUBLIC: Return sequence number element name.
void	setJavaClass(java.lang.Class javaClass) PUBLIC: Set the Java class that this descriptor maps.
void	setPrimaryKeyElementName(java.lang.String elementName) PUBLIC: Specify the primary key element for the descriptor.
void	setPrimaryKeyElementNames(java.lang.String[] primaryKeyElementNames) PUBLIC: Specify an array of all the primary key element names, if the primary key is composed of multiple elements.
void	setPrimaryKeyElementNames(java.util.Vector primaryKeyElementNames) PUBLIC: Specify a vector of all the primary key element names, if the primary key is composed of multiple elements.
void	setRootElementName(java.lang.String rootElementName) PUBLIC: Specify the root element name for the class of objects the descriptor maps.
void	setSequenceNumberElementName(java.lang.String elementName) PUBLIC: Set the sequence number element name.

Methods inherited from class oracle.toplink.sdk.SDKDescriptor

addReadAllCall, addReadAllCall, addReadAllCall, addReadAllCall, addReadAllCall, addReadAllCall, addReadObjectCall, addReadObjectCall, addReadObjectCall, addReadObjectCall, addReadObjectCall, addReadObjectCall, addReadTranslation, addReadTranslations, addReadTranslations, addWriteTranslation, addWriteTranslations, addWriteTranslations, getDataTypeName, setDataTypeName, setDeleteCall, setDoesExistCall, setInsertCall, setQueryManager, setReadAllCall, setReadObjectCall, setUpdateCall

Methods inherited from class oracle.toplink.publicinterface.Descriptor

addAbstractQueryKey, addConstraintDependencies, addDirectMapping, addDirectMapping, addDirectQueryKey, addMapping, addMultipleTableForeignKeyFieldName, addMultipleTablePrimaryKeyFieldName, addPrimaryKeyFieldName, addQueryKey, addTableName, alwaysConformResultsInUnitOfWork, alwaysRefreshCache, alwaysRefreshCacheOnRemote, applyAmendmentMethod, createCopyPolicy, createInstantiationPolicy, descriptorIsAggregate, descriptorIsAggregateCollection, descriptorIsForInterface, descriptorIsNormal, disableCacheHits, disableCacheHitsOnRemote, dontAlwaysConformResultsInUnitOfWork, dontAlwaysRefreshCache, dontAlwaysRefreshCacheOnRemote, dontDisableCacheHits, dontDisableCacheHitsOnRemote, dontOnlyRefreshCacheIfNewerVersion, getAlias, getAmendmentClass, getAmendmentMethodName, getConstraintDependencies, getDescriptorType, getEventManager, getIdentityMapSize, getInheritancePolicy, getInterfacePolicy, getJavaClass, getMappingForAttributeName, getMappings, getOptimisticLockingPolicy, getPrimaryKeyFieldNames, getProperties, getProperty, getQueryKeys, getQueryManager, getRemoteIdentityMapSize, getSequenceNumberFieldName, getSequenceNumberName, getTableName, getTableNames, getWrapperPolicy, isAggregateCollectionDescriptor, isAggregateDescriptor, isChildDescriptor, isDescriptorForInterface, onlyRefreshCacheIfNewerVersion, removeProperty, setAlias, setAmendmentClass, setAmendmentMethodName, setConstraintDependencies, setDefaultTableName, setDescriptorType, setIdentityMapClass, setIdentityMapSize, setIsAggregateDescriptor, setIsDescriptorForInterface, setJavaInterface, setMultipleTableInsertOrder, setOptimisticLockingPolicy, setPrimaryKeyFieldName, setPrimaryKeyFieldNames, setProperty, setReadOnly, setRemoteIdentityMapClass, setRemoteIdentityMapSize, setSequenceNumberFieldName, setSequenceNumberName, setShouldAlwaysConformResultsInUnitOfWork, setShouldAlwaysRefreshCache, setShouldAlwaysRefreshCacheOnRemote, setShouldBeReadOnly, setShouldDisableCacheHits, setShouldDisableCacheHitsOnRemote, setShouldOnlyRefreshCacheIfNewerVersion, setShouldOrderMappings, setTableName, setTableNames, setTableQualifier, setWrapperPolicy, setWriteLockFieldName, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldAlwaysRefreshCacheOnRemote, shouldBeReadOnly, shouldDisableCacheHits, shouldDisableCacheHitsOnRemote, shouldOnlyRefreshCacheIfNewerVersion, shouldUseCacheIdentityMap, shouldUseFullIdentityMap, shouldUseHardCacheWeakIdentityMap, shouldUseNoIdentityMap, shouldUseRemoteCacheIdentityMap, shouldUseRemoteFullIdentityMap, shouldUseRemoteHardCacheWeakIdentityMap, shouldUseRemoteNoIdentityMap, shouldUseRemoteSoftCacheWeakIdentityMap, shouldUseRemoteWeakIdentityMap, shouldUseSoftCacheWeakIdentityMap, shouldUseWeakIdentityMap, toString, useAllFieldsLocking, useCacheIdentityMap, useChangedFieldsLocking, useCloneCopyPolicy, useCloneCopyPolicy, useConstructorCopyPolicy, useDefaultConstructorInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFullIdentityMap, useHardCacheWeakIdentityMap, useInstantiationCopyPolicy, useMethodInstantiationPolicy, useNoIdentityMap, useRemoteCacheIdentityMap, useRemoteFullIdentityMap, useRemoteHardCacheWeakIdentityMap, useRemoteNoIdentityMap, useRemoteSoftCacheWeakIdentityMap, useRemoteWeakIdentityMap, usesCacheIdentityMap, useSelectedFieldsLocking, usesFullIdentityMap, usesHardCacheWeakIdentityMap, usesNoIdentityMap, useSoftCacheWeakIdentityMap, usesOptimisticLocking, usesSequenceNumbers, usesSoftCacheWeakIdentityMap, usesWeakIdentityMap, useTimestampLocking, useTimestampLocking, useVersionLocking, useVersionLocking, useWeakIdentityMap

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLDescriptor

public XMLDescriptor()

PUBLIC: Default constructor.

Method Detail

addPrimaryKeyElementName

public void addPrimaryKeyElementName(java.lang.String elementName)

PUBLIC: Add a primary key element for the descriptor. This should be called for each element that makes up the primary key. The order in which these elements are added may be significant.

getPrimaryKeyElementNames

public java.util.Vector getPrimaryKeyElementNames()

PUBLIC: Return the names of all the primary key elements.

getRootElementName

public java.lang.String getRootElementName()
                                    throws DescriptorException

PUBLIC: Return the root element name for the class of objects the descriptor maps.

Throws:

DescriptorException

getSequenceNumberElementName

public java.lang.String getSequenceNumberElementName()

PUBLIC: Return sequence number element name.

setJavaClass

public void setJavaClass(java.lang.Class javaClass)

PUBLIC: Set the Java class that this descriptor maps. Every descriptor maps one and only one class.

Overrides:

setJavaClass in class Descriptor

setPrimaryKeyElementName

public void setPrimaryKeyElementName(java.lang.String elementName)

PUBLIC: Specify the primary key element for the descriptor. This should only be called if primary key is made up of a single element; otherwise #addPrimaryKeyElementName() should be called.

See Also:

addPrimaryKeyElementName(String)

setPrimaryKeyElementNames

public void setPrimaryKeyElementNames(java.lang.String[] primaryKeyElementNames)

PUBLIC: Specify an array of all the primary key element names, if the primary key is composed of multiple elements. The order of these elements may be significant.

See Also:

addPrimaryKeyElementName(String)

setPrimaryKeyElementNames

public void setPrimaryKeyElementNames(java.util.Vector primaryKeyElementNames)

PUBLIC: Specify a vector of all the primary key element names, if the primary key is composed of multiple elements. The order of these elements may be significant.

See Also:

addPrimaryKeyElementName(String)

setRootElementName

public void setRootElementName(java.lang.String rootElementName)
                        throws DescriptorException

PUBLIC: Specify the root element name for the class of objects the descriptor maps.

Throws:

DescriptorException

setSequenceNumberElementName

public void setSequenceNumberElementName(java.lang.String elementName)

PUBLIC: Set the sequence number element name. This is the field whose value is to be generated by TopLink. This is normally the primary key element for the descriptor.