oracle.toplink.eis
Class EISDescriptor
java.lang.Object
oracle.toplink.descriptors.ClassDescriptor
oracle.toplink.eis.EISDescriptor
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
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
,
oracle.toplink.eis.mappings.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
|
Methods inherited from class oracle.toplink.descriptors.ClassDescriptor |
addAbstractQueryKey, addConstraintDependencies, addDirectQueryKey, addForeignKeyFieldForMultipleTable, addForeignKeyFieldNameForMultipleTable, addMapping, addMultipleTableForeignKeyField, addMultipleTableForeignKeyFieldName, addMultipleTablePrimaryKeyField, addMultipleTablePrimaryKeyFieldName, addPrimaryKeyField, addQueryKey, addTable, addTableName, 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, getEventManager, getFetchGroupManager, getHistoryPolicy, getIdentityMapSize, getInterfacePolicy, getJavaClass, getJavaClassName, getMappingForAttributeName, getMappings, getObjectChangePolicy, getOptimisticLockingPolicy, getPrimaryKeyFieldNames, getProperties, getProperty, getQueryKeys, getQueryManager, getRemoteIdentityMapSize, getReturningPolicy, getSequenceNumberFieldName, getSequenceNumberName, getTableName, getTableNames, getUnitOfWorkCacheIsolationLevel, getWrapperPolicy, isAggregateCollectionDescriptor, isAggregateDescriptor, isChildDescriptor, isDescriptorForInterface, isIsolated, isNativeConnectionRequired, isObjectRelationalDescriptor, onlyRefreshCacheIfNewerVersion, removeMappingForAttributeName, removeProperty, setAlias, setAmendmentClass, setAmendmentMethodName, setCacheInvalidationPolicy, setCacheSynchronizationType, setCMPPolicy, setConstraintDependencies, setDefaultTableName, setDescriptorType, setFetchGroupManager, setHistoryPolicy, setIdentityMapClass, setIdentityMapSize, setIsIsolated, setIsNativeConnectionRequired, setJavaClass, setJavaInterface, setMultipleTableInsertOrder, setObjectChangePolicy, setOptimisticLockingPolicy, setPrimaryKeyFieldName, setPrimaryKeyFieldNames, setProperty, setReadOnly, setRemoteIdentityMapClass, setRemoteIdentityMapSize, setReturningPolicy, setSequenceNumberName, setShouldAlwaysConformResultsInUnitOfWork, setShouldAlwaysRefreshCache, setShouldAlwaysRefreshCacheOnRemote, setShouldBeReadOnly, setShouldDisableCacheHits, setShouldDisableCacheHitsOnRemote, setShouldOnlyRefreshCacheIfNewerVersion, setShouldOrderMappings, setTableName, setTableNames, setTableQualifier, setUnitOfWorkCacheIsolationLevel, setWrapperPolicy, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldAlwaysRefreshCacheOnRemote, shouldBeReadOnly, shouldDisableCacheHits, shouldDisableCacheHitsOnRemote, shouldOnlyRefreshCacheIfNewerVersion, shouldUseCacheIdentityMap, shouldUseFullIdentityMap, shouldUseHardCacheWeakIdentityMap, shouldUseNoIdentityMap, shouldUseRemoteCacheIdentityMap, shouldUseRemoteFullIdentityMap, shouldUseRemoteHardCacheWeakIdentityMap, shouldUseRemoteNoIdentityMap, shouldUseRemoteSoftCacheWeakIdentityMap, shouldUseRemoteSoftIdentityMap, shouldUseRemoteWeakIdentityMap, shouldUseSoftCacheWeakIdentityMap, shouldUseSoftIdentityMap, shouldUseWeakIdentityMap, toString, useAllFieldsLocking, useCacheIdentityMap, useChangedFieldsLocking, useCloneCopyPolicy, useCloneCopyPolicy, useDefaultConstructorInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFullIdentityMap, useHardCacheWeakIdentityMap, useInstantiationCopyPolicy, useMethodInstantiationPolicy, useNoIdentityMap, useRemoteCacheIdentityMap, useRemoteFullIdentityMap, useRemoteHardCacheWeakIdentityMap, useRemoteNoIdentityMap, useRemoteSoftCacheWeakIdentityMap, useRemoteSoftIdentityMap, useRemoteWeakIdentityMap, useSelectedFieldsLocking, useSoftCacheWeakIdentityMap, useSoftIdentityMap, usesOptimisticLocking, usesSequenceNumbers, usesVersionLocking, useTimestampLocking, useTimestampLocking, useVersionLocking, useVersionLocking, useWeakIdentityMap |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MAPPED
public static final java.lang.String MAPPED
- Description copied from class:
EISDescriptor
- 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
EISDescriptor
public EISDescriptor()
- Default constructor.
setDataTypeName
public void setDataTypeName(java.lang.String dataTypeName)
throws DescriptorException
- 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()
- Return the XML namespace resolver.
XML type EIS descriptor can use a namespace resolver to support XML schema namespaces.
getInheritancePolicy
public InheritancePolicy getInheritancePolicy()
- 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 ClassDescriptor
setNamespaceResolver
public void setNamespaceResolver(NamespaceResolver namespaceResolver)
- 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()
- Return the data format that the descriptor maps to.
getDataTypeName
public java.lang.String getDataTypeName()
throws DescriptorException
- 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)
- Configure the data format that the descriptor maps to.
useMappedRecordFormat
public void useMappedRecordFormat()
- Configure the data format to use mapped records.
useIndexedRecordFormat
public void useIndexedRecordFormat()
- Configure the data format to use indexed records.
useXMLRecordFormat
public void useXMLRecordFormat()
- Configure the data format to use xml records.
addDirectMapping
public DatabaseMapping addDirectMapping(java.lang.String attributeName,
java.lang.String fieldName)
- 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
- Parameters:
String
- instanceVariableName is the name of an instance variable of the
class which the receiver describes.String
- fieldName is the name 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 fieldName)
- 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)
- 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:
ClassDescriptor.addMultipleTableForeignKeyFieldName(String, String);
setSequenceNumberFieldName
public void setSequenceNumberFieldName(java.lang.String fieldName)
- 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