public class RelationalDescriptor extends ClassDescriptor
Purpose: TopLink has been designed to take advantage of the similarities between relational databases and objects while accommodating for their differences, providing an object oriented wrapper for relational databases. This is accomplished through the use of Descriptors. A descriptor is a pure specification class with all its behaviour deputized to DescriptorEventManager, DescriptorQueryManager and ObjectBuilder. Look at the following variables for the list of specification on the descriptor.
A Descriptor is a set of mappings that describe how an objects's data is to be represented in a relational database. It contains mappings from the class instance variables to the table's fields, as well as the transformation routines necessary for storing and retrieving attributes. As such the descriptor acts as the link between the Java object and its database representaiton.
Every descripor is initialized with the following information:
This descriptor subclass should be used for object-relational mapping, and allows for other datatype mappings to be done in the XML, EIS and OR sibling classes.
DescriptorEventManager
,
DescriptorQueryManager
,
InheritancePolicy
,
InterfacePolicy
,
Serialized FormadditionalTablePrimaryKeyFields, AGGREGATE, AGGREGATE_COLLECTION, alias, allFields, amendmentClass, amendmentClassName, amendmentMethodName, cacheInvalidationPolicy, cascadeLockingPolicies, changePolicy, cmpPolicy, constraintDependencies, copyPolicy, defaultTable, descriptorType, ERROR, eventManager, fetchGroupManager, fields, hasSimplePrimaryKey, identityMapClass, identityMapSize, inheritancePolicy, initializationStage, INITIALIZED, instantiationPolicy, isIsolated, javaClass, javaClassName, lockableMappings, mappings, multipleTableForeignKeys, multipleTableInsertOrder, NORMAL, objectBuilder, optimisticLockingPolicy, POST_INITIALIZED, PREINITIALIZED, primaryKeyFields, properties, queryKeys, queryManager, sequenceNumberField, sequenceNumberName, sessionName, shouldAcquireCascadedLocks, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldBeReadOnly, shouldDisableCacheHits, shouldOnlyRefreshCacheIfNewerVersion, shouldOrderMappings, shouldRegisterResultsInUnitOfWork, tables, UNINITIALIZED, wrapperPolicy
Constructor and Description |
---|
RelationalDescriptor()
PUBLIC:
Return a new descriptor.
|
Modifier and Type | Method and Description |
---|---|
void |
addTableName(String tableName)
PUBLIC:
Specify the table name for the class of objects the receiver describes.
|
String |
getTableName()
PUBLIC:
Return the name of the descriptor's first table.
|
Vector |
getTableNames()
PUBLIC:
Return the table names.
|
void |
setDefaultTableName(String defaultTableName)
PUBLIC:
The descriptors default table can be configured if the first table is not desired.
|
void |
setTableName(String tableName)
PUBLIC:
Specify the table name for the class of objects the receiver describes.
|
void |
setTableNames(Vector tableNames)
PUBLIC:
Specify the all table names for the class of objects the receiver describes.
|
void |
setTableQualifier(String tableQualifier)
PUBLIC: Set the table Qualifier for this descriptor.
|
addAbstractQueryKey, addConstraintDependencies, addDirectMapping, addDirectMapping, addDirectQueryKey, addMapping, addMultipleTableForeignKeyField, addMultipleTableForeignKeyFieldName, addMultipleTableForeignKeys, addMultipleTableForeignKeys, addMultipleTablePrimaryKeyField, addMultipleTablePrimaryKeyFieldName, addPrimaryKeyField, addPrimaryKeyFieldName, addQueryKey, addTable, adjustMultipleTableInsertOrder, alwaysConformResultsInUnitOfWork, alwaysRefreshCache, applyAmendmentMethod, applyAmendmentMethod, arePrimaryKeyFields, buildCallFromStatement, buildDirectValuesFromFieldValue, buildField, buildField, buildFieldValueFromDirectValues, buildFieldValueFromForeignKeys, buildFieldValueFromNestedRow, buildFieldValueFromNestedRows, buildNestedRowFromFieldValue, buildNestedRowsFromFieldValue, checkDatabase, checkInheritanceTreeAggregateSettings, checkMultipleTableForeignKeys, clone, convertClassNamesToClasses, createCopyPolicy, createInstantiationPolicy, descriptorIsAggregate, descriptorIsAggregateCollection, descriptorIsNormal, disableCacheHits, dontAlwaysConformResultsInUnitOfWork, dontAlwaysRefreshCache, dontDisableCacheHits, dontOnlyRefreshCacheIfNewerVersion, extractDefaultTable, getAdditionalTablePrimaryKeyFields, getAlias, getAllFields, getAmendmentClass, getAmendmentClassName, getAmendmentMethodName, getCacheInvalidationPolicy, getCascadeLockingPolicies, getCMPPolicy, getConstraintDependencies, getCopyPolicy, getDefaultFetchGroup, getDefaultTable, getDescriptorEventManager, getDescriptorInheritancePolicy, getDescriptorQueryManager, getDescriptorType, getDescriptorTypeValue, getEventManager, getFetchGroupManager, getFields, getIdentityMapClass, getIdentityMapSize, getInheritancePolicy, getInheritancePolicyOrNull, getInstantiationPolicy, getJavaClass, getJavaClassName, getLockableMappings, getMappingForAttributeName, getMappings, getMultipleTableForeignKeyAssociations, getMultipleTableForeignKeys, getMultipleTableInsertOrder, getMultipleTablePrimaryKeyAssociations, getObjectBuilder, getObjectChangePolicy, getOptimisticLockingPolicy, getPrimaryKeyFieldNames, getPrimaryKeyFields, getProperties, getProperty, getQueryKeyNamed, getQueryKeys, getQueryManager, getSequenceNumberField, getSequenceNumberFieldName, getSequenceNumberName, getSessionName, getTable, getTables, getTypedField, getWrapperPolicy, hasCascadeLockingPolicies, hasCMPPolicy, hasDependencyOnParts, hasFetchGroupManager, hasInheritance, hasMultipleTables, hasPrivatelyOwnedParts, hasQueryKeyOrMapping, hasSimplePrimaryKey, hasWrapperPolicy, initialize, initializeAggregateInheritancePolicy, initializeMultipleTablePrimaryKeyFields, initializePrimaryKey, initializeProperties, isAggregateCollectionDescriptor, isAggregateDescriptor, isChildDescriptor, isDescriptorForCMP, isFullyInitialized, isInitialized, isInvalid, isIsolated, isMultipleTableDescriptor, isPrimaryKeySetAfterInsert, onlyRefreshCacheIfNewerVersion, postInitialize, preInitialize, preInitializeInheritancePolicy, prepareCascadeLockingPolicy, rehashFieldDependancies, reInitializeJoinedAttributes, removeMappingForAttributeName, removeProperty, requiresInitialization, selfValidationAfterInitialization, selfValidationBeforeInitialization, setAdditionalTablePrimaryKeyFields, setAdditionalTablePrimaryKeyFields, setAlias, setAllFields, setAmendmentClass, setAmendmentClassName, setAmendmentMethodName, setCacheInvalidationPolicy, setCMPPolicy, setConstraintDependencies, setCopyPolicy, setDefaultTable, setDescriptorType, setDescriptorTypeValue, setEventManager, setExistenceChecking, setFetchGroupManager, setFields, setHasSimplePrimaryKey, setIdentityMapClass, setIdentityMapSize, setInheritancePolicy, setInitializationStage, setInstantiationPolicy, setIsIsolated, setJavaClass, setJavaClassName, setLockableMappings, setMappings, setMultipleTableForeignKeyFieldNames, setMultipleTableForeignKeys, setMultipleTableInsertOrder, setMultipleTablePrimaryKeyFieldNames, setObjectBuilder, setObjectChangePolicy, setOptimisticLockingPolicy, setPrimaryKeyFieldName, setPrimaryKeyFieldNames, setPrimaryKeyFields, setProperties, setProperty, setQueryKeys, setQueryManager, setReadOnly, setSequenceNumberField, setSequenceNumberFieldName, setSequenceNumberName, setSessionName, setShouldAcquireCascadedLocks, setShouldAlwaysConformResultsInUnitOfWork, setShouldAlwaysRefreshCache, setShouldBeReadOnly, setShouldDisableCacheHits, setShouldOnlyRefreshCacheIfNewerVersion, setShouldOrderMappings, setShouldRegisterResultsInUnitOfWork, setTables, setWrapperPolicy, shouldAcquireCascadedLocks, shouldAlwaysConformResultsInUnitOfWork, shouldAlwaysRefreshCache, shouldBeReadOnly, shouldDisableCacheHits, shouldOnlyRefreshCacheIfNewerVersion, shouldOrderMappings, shouldRegisterResultsInUnitOfWork, shouldUseCacheIdentityMap, shouldUseFullIdentityMap, shouldUseHardCacheWeakIdentityMap, shouldUseNoIdentityMap, shouldUseSoftCacheWeakIdentityMap, shouldUseWeakIdentityMap, toggleAdditionalTablePrimaryKeyFields, toString, useCacheIdentityMap, useCloneCopyPolicy, useCloneCopyPolicy, useDefaultConstructorInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFactoryInstantiationPolicy, useFullIdentityMap, useHardCacheWeakIdentityMap, useInstantiationCopyPolicy, useMethodInstantiationPolicy, useNoIdentityMap, useSoftCacheWeakIdentityMap, usesOptimisticLocking, usesSequenceNumbers, usesVersionLocking, useTimestampLocking, useTimestampLocking, useVersionLocking, useVersionLocking, useWeakIdentityMap, validateAfterInitialization, validateBeforeInitialization, validateMappingType, verifyTableQualifiers
public RelationalDescriptor()
public void addTableName(String tableName)
addTableName
in class ClassDescriptor
public String getTableName()
getTableName
in class ClassDescriptor
public Vector getTableNames()
getTableNames
in class ClassDescriptor
public void setDefaultTableName(String defaultTableName)
setDefaultTableName
in class ClassDescriptor
public void setTableName(String tableName) throws DescriptorException
setTableName
in class ClassDescriptor
DescriptorException
public void setTableNames(Vector tableNames)
setTableNames
in class ClassDescriptor
public void setTableQualifier(String tableQualifier)
setTableQualifier
in class ClassDescriptor
Copyright © 2022. All rights reserved.