oracle.toplink.eis
Class EISDescriptor

java.lang.Object
  oracle.toplink.publicinterface.Descriptor
      oracle.toplink.internal.descriptors.RootDescriptor
          oracle.toplink.descriptors.ClassDescriptor
              oracle.toplink.eis.EISDescriptor

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class EISDescriptor

extends ClassDescriptor

An EISDescriptor defines the mapping from a JCA data structure to a Java object. There are two types of EIS descriptors:

• Root - indicates to the TopLink runtime that the EIS descriptor's reference class is a parent class: no other class will reference it by way of a composite object mapping or composite collection mapping. For an EIS root descriptor, EIS interactions can be defined to invoke methods on an EIS
• Composite - indicates to the TopLink runtime that the EIS descriptor's reference class may be referenced by a composite object mapping or composite collection mapping

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

EISInteraction, EISMapping, Serialized Form

Field Summary

static java.lang.String	INDEXED
static java.lang.String	MAPPED Define the valid data formats that the descriptor can map to.
static java.lang.String	XML

Fields inherited from class oracle.toplink.publicinterface.Descriptor

DO_NOT_SEND_CHANGES, INVALIDATE_CHANGED_OBJECTS, SEND_NEW_OBJECTS_WITH_CHANGES, SEND_OBJECT_CHANGES, UNDEFINED_OBJECT_CHANGE_BEHAVIOR

Constructor Summary

EISDescriptor()
Default constructor.

Method Summary

DatabaseMapping	addDirectMapping(java.lang.String attributeName, java.lang.String fieldName) PUBLIC: Add a direct mapping to the receiver.
DatabaseMapping	addDirectMapping(java.lang.String attributeName, java.lang.String getMethodName, java.lang.String setMethodName, java.lang.String fieldName) PUBLIC: Add a direct to node mapping to the receiver.
void	addPrimaryKeyFieldName(java.lang.String fieldName) PUBLIC: Specify the primary key field.
java.lang.String	getDataFormat() PUBLIC: Return the data format that the descriptor maps to.
java.lang.String	getDataTypeName() PUBLIC: Specify the data type name for the class of objects the descriptor maps.
InheritancePolicy	getInheritancePolicy() PUBLIC: The inheritance policy is used to define how a descriptor takes part in inheritance.
NamespaceResolver	getNamespaceResolver() PUBLIC: Return the XML namespace resolver.
void	setDataFormat(java.lang.String dataFormat) PUBLIC: Configure the data format that the descriptor maps to.
void	setDataTypeName(java.lang.String dataTypeName) PUBLIC: Specify the data type name for the class of objects the descriptor maps.
void	setNamespaceResolver(NamespaceResolver namespaceResolver) PUBLIC: Set the XML namespace resolver.
void	setSequenceNumberFieldName(java.lang.String fieldName) PUBLIC: Set the sequence number field name.
void	useIndexedRecordFormat() PUBLIC: Configure the data format to use indexed records.
void	useMappedRecordFormat() PUBLIC: Configure the data format to use mapped records.
void	useXMLRecordFormat() PUBLIC: Configure the data format to use xml records.

Methods inherited from class oracle.toplink.descriptors.ClassDescriptor

addAbstractQueryKey, addConstraintDependencies, addDirectQueryKey, addMapping, addMultipleTableForeignKeyFieldName, addMultipleTablePrimaryKeyFieldName, addPrimaryKeyField, addQueryKey, alwaysConformResultsInUnitOfWork, alwaysRefreshCache, alwaysRefreshCacheOnRemote, applyAmendmentMethod, createCopyPolicy, createInstantiationPolicy, descriptorIsAggregate, descriptorIsAggregateCollection, descriptorIsForInterface, descriptorIsNormal, disableCacheHits, disableCacheHitsOnRemote, dontAlwaysConformResultsInUnitOfWork, dontAlwaysRefreshCache, dontAlwaysRefreshCacheOnRemote, dontDisableCacheHits, dontDisableCacheHitsOnRemote, dontOnlyRefreshCacheIfNewerVersion, getAlias, getAmendmentClass, getAmendmentMethodName, getCacheInvalidationPolicy, getCacheSynchronizationType, getCMPPolicy, getConstraintDependencies, getDescriptorEventManager, getDescriptorInheritancePolicy, getDescriptorQueryManager, getDescriptorType, getFetchGroupManager, getHistoryPolicy, getIdentityMapSize, getInterfacePolicy, getJavaClass, getMappingForAttributeName, getMappings, getObjectChangePolicy, getOptimisticLockingPolicy, getPrimaryKeyFieldNames, getProperties, getProperty, getQueryKeys, getRemoteIdentityMapSize, getReturningPolicy, getSequenceNumberFieldName, getSequenceNumberName, getWrapperPolicy, isAggregateCollectionDescriptor, isAggregateDescriptor, isChildDescriptor, isDescriptorForInterface, isIsolated, onlyRefreshCacheIfNewerVersion, removeProperty, setAlias, setAmendmentClass, setAmendmentMethodName, setCacheInvalidationPolicy, setCacheSynchronizationType, setCMPPolicy, setDescriptorType, setFetchGroupManager, setHistoryPolicy, setIdentityMapClass, setIdentityMapSize, setIsIsolated, setJavaClass, setJavaInterface, setObjectChangePolicy, setOptimisticLockingPolicy, setPrimaryKeyFieldName, setPrimaryKeyFieldNames, setProperty, setReadOnly, setRemoteIdentityMapClass, setRemoteIdentityMapSize, setReturningPolicy, setSequenceNumberName, setShouldAlwaysConformResultsInUnitOfWork, setShouldAlwaysRefreshCache, setShouldAlwaysRefreshCacheOnRemote, setShouldBeReadOnly, setShouldDisableCacheHits, setShouldDisableCacheHitsOnRemote, setShouldOnlyRefreshCacheIfNewerVersion, setShouldOrderMappings, setWrapperPolicy, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldAlwaysRefreshCacheOnRemote, shouldBeReadOnly, shouldDisableCacheHits, shouldDisableCacheHitsOnRemote, shouldOnlyRefreshCacheIfNewerVersion, shouldUseCacheIdentityMap, shouldUseFullIdentityMap, shouldUseHardCacheWeakIdentityMap, shouldUseNoIdentityMap, shouldUseRemoteCacheIdentityMap, shouldUseRemoteFullIdentityMap, shouldUseRemoteHardCacheWeakIdentityMap, shouldUseRemoteNoIdentityMap, shouldUseRemoteSoftCacheWeakIdentityMap, shouldUseRemoteWeakIdentityMap, shouldUseSoftCacheWeakIdentityMap, shouldUseWeakIdentityMap, useAllFieldsLocking, useCacheIdentityMap, useChangedFieldsLocking, useCloneCopyPolicy, useCloneCopyPolicy, useDefaultConstructorInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFullIdentityMap, useHardCacheWeakIdentityMap, useInstantiationCopyPolicy, useMethodInstantiationPolicy, useNoIdentityMap, useRemoteCacheIdentityMap, useRemoteFullIdentityMap, useRemoteHardCacheWeakIdentityMap, useRemoteNoIdentityMap, useRemoteSoftCacheWeakIdentityMap, useRemoteWeakIdentityMap, useSelectedFieldsLocking, useSoftCacheWeakIdentityMap, usesOptimisticLocking, usesSequenceNumbers, useTimestampLocking, useTimestampLocking, useVersionLocking, useVersionLocking, useWeakIdentityMap

Methods inherited from class oracle.toplink.publicinterface.Descriptor

addTableName, getEventManager, getJavaClassName, getQueryManager, getTableName, getTableNames, removeMappingForAttributeName, setConstraintDependencies, setDefaultTableName, setMultipleTableInsertOrder, setTableName, setTableNames, setTableQualifier, toString

Methods inherited from class java.lang.Object

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

Field Detail

MAPPED

public static final java.lang.String MAPPED

Define the valid data formats that the descriptor can map to.

See Also:

Constant Field Values

INDEXED

public static final java.lang.String INDEXED

See Also:

Constant Field Values

XML

public static final java.lang.String XML

See Also:

Constant Field Values

Constructor Detail

EISDescriptor

public EISDescriptor()

Default constructor.

Method Detail

setDataTypeName

public void setDataTypeName(java.lang.String dataTypeName)
                     throws DescriptorException

PUBLIC: Specify the data type name for the class of objects the descriptor maps. This may be the XML schema complex type name, or the JCA record name for the type being mapped.

Throws:

DescriptorException

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

PUBLIC: Return the XML namespace resolver. XML type EIS descriptor can use a namespace resolver to support XML schema namespaces.

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.

Overrides:

getInheritancePolicy in class Descriptor

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver namespaceResolver)

PUBLIC: Set the XML namespace resolver. XML type EIS descriptor can use a namespace resolver to support XML schema namespaces.

getDataFormat

public java.lang.String getDataFormat()

PUBLIC: Return the data format that the descriptor maps to.

getDataTypeName

public java.lang.String getDataTypeName()
                                 throws DescriptorException

PUBLIC: Specify the data type name for the class of objects the descriptor maps. This may be the XML schema complex type name, or the JCA record name for the type being mapped.

Throws:

DescriptorException

setDataFormat

public void setDataFormat(java.lang.String dataFormat)

PUBLIC: Configure the data format that the descriptor maps to.

useMappedRecordFormat

public void useMappedRecordFormat()

PUBLIC: Configure the data format to use mapped records.

useIndexedRecordFormat

public void useIndexedRecordFormat()

PUBLIC: Configure the data format to use indexed records.

useXMLRecordFormat

public void useXMLRecordFormat()

PUBLIC: Configure the data format to use xml records.

addDirectMapping

public DatabaseMapping addDirectMapping(java.lang.String attributeName,
                                        java.lang.String fieldName)

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:

addDirectMapping in class ClassDescriptor

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 fieldName)

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:

addDirectMapping in class ClassDescriptor

addPrimaryKeyFieldName

public void addPrimaryKeyFieldName(java.lang.String fieldName)

PUBLIC: Specify the primary key field. This should be called for each field that make up the primary key. For EIS XML Descriptors use the addPrimaryKeyField(DatabaseField) API and supply an oracle.toplink.ox.XMLField parameter instead of using this method

Overrides:

addPrimaryKeyFieldName in class ClassDescriptor

See Also:

#addMultipleTableForeignKeyFieldName(String, String);

setSequenceNumberFieldName

public void setSequenceNumberFieldName(java.lang.String fieldName)

PUBLIC: Set the sequence number field name. This is the field in the descriptors table that needs its value to be generated. This is normally the primary key field of the descriptor. For EIS XML Descriptors use the setSequenceNumberFieldName(DatabaseField) API and supply an oracle.toplink.ox.XMLField parameter instead of using this method

Overrides:

setSequenceNumberFieldName in class ClassDescriptor