oracle.toplink.tools.ejb11
Class CMPBeanDefinition

java.lang.Object
oracle.toplink.tools.ejb11.BeanInformationDefinition
oracle.toplink.tools.ejb11.CMPBeanDefinition

public class CMPBeanDefinition

extends BeanInformationDefinition

This class loads, stores and provides access to the deployment properties of a TopLink CMP bean. It is the main object of the DOM generated from the XML input provided to the BeanDefinitionLoader

Field Summary

static java.lang.String	ASYNCHRONOUS
static java.lang.String	CHECK_CACHE_BY_EXACT_PRIMARY_KEY
static java.lang.String	CHECK_CACHE_BY_PRIMARY_KEY
static java.lang.String	CHECK_CACHE_ONLY
static java.lang.String	CHECK_CACHE_THEN_DATABASE
static java.lang.String	CONFORM_RESULTS_IN_UNIT_OF_WORK
static java.lang.String	DO_NOT_CHECK_CACHE
static java.lang.String	SYNCHRONOUS
static java.lang.String	TI_TRANSACTION_NONE
static java.lang.String	TI_TRANSACTION_READ_COMMITTED
static java.lang.String	TI_TRANSACTION_READ_UNCOMMITTED
static java.lang.String	TI_TRANSACTION_REPEATABLE_READ
static java.lang.String	TI_TRANSACTION_SERIALIZABLE

Fields inherited from class oracle.toplink.tools.ejb11.BeanInformationDefinition

BEAN_ATTRIBUTES, CACHE_USAGE, CMP_3_5_DTD_NAME, CMP_DTD_LOCATION, CMP_DTD_NAME, CUSTOMIZATION_CLASS, FINDER, FINDER_LIST, FINDER_QUERY, FINDER_TYPE, LOG_DESTINATION, LOG_MESSAGES, METHOD_NAME, METHOD_PARAM, METHOD_PARAMS, PARAM_NAME, PARAM_TYPE, PROJECT, PROJECT_CLASS, PROJECT_DATA_SOURCE, PROJECT_FILE, PROJECT_IDENTIFIER, PROJECT_OPTIONS, PROJECT_PLATFORM, PROJECT_POOL_NAME, PROJECT_READ_ONLY_DATA_SOURCE, PROJECT_TRANSACTION_ISOLATION, READ_ONLY, REFRESH_CACHE, TOPLINK_3_0_DOCTYPE_DESC, TOPLINK_3_5_DOCTYPE_DESC, TOPLINK_CMP_BEAN, TOPLINK_DOCTYPE_DESC, TOPLINK_DOCTYPE_URL, UPDATE_PROPAGATION

Constructor Summary

CMPBeanDefinition()

CMPBeanDefinition(org.w3c.dom.Element beanElem)

CMPBeanDefinition(java.lang.String beanName)

Method Summary

void	addFinder(FinderDefinition finder)
java.util.Properties	getBeanProperties()
java.lang.String	getBeanProperty(java.lang.String tagName)
java.lang.String	getCacheUsage() Return the String that represents the cache usage level for queries.
java.lang.String	getCustomizationClassName()
java.lang.String	getEjbName()
FinderDefinition	getFinder(java.lang.String finderName)
java.util.Hashtable	getFinderList()
java.lang.String	getJdbcLevel() Deprecated.
java.lang.String	getLogDestination()
boolean	getLogMessages()
ProjectDefinition	getProject()
java.lang.String	getProjectClassName()
java.lang.String	getProjectDataSource()
java.lang.String	getProjectFileName()
java.lang.String	getProjectIdentifier()
java.lang.String	getProjectPlatform()
java.lang.String	getProjectPoolName()
java.lang.String	getProjectReadOnlyDataSource()
java.lang.Boolean	getReadOnly() Return the Boolean object that contains true if the read-only attribute has been set to true, or false if it has been set to false.
java.lang.Boolean	getRefreshCache() Return the Boolean object that contains true if the refresh cache option for finders has been set to true, or false if it has been set to false.
java.lang.String	getTransactionIsolation()
java.lang.String	getUpdatePropagation()
void	initializeBeanPropertiesElement()
static int	intValueFromCacheUsageString(java.lang.String cacheUsageString)
static int	intValueFromTxnIsolationString(java.lang.String txnIsolationString)
static int	intValueFromUpdatePropagationString(java.lang.String updatePropagationString)
void	loadProperties() Precondition: The beanElement has been correctly initialized.
void	setBeanElement(org.w3c.dom.Element newValue)
void	setBeanPropertiesElement(org.w3c.dom.Element newValue)
void	setCacheUsage(java.lang.String cacheUsageString) Set the cache usage level for finders.
void	setEJBName(java.lang.String ejbName)
void	setFinderList(java.util.Hashtable finderList)
void	setProject(ProjectDefinition newValue)
void	setReadOnly(java.lang.Boolean readOnlyFlag) Set the read-only attribute for this bean.
void	setRefreshCache(java.lang.Boolean refreshFlag) Set the refresh cache option for finders.
org.w3c.dom.Document	storeProperties()

Methods inherited from class oracle.toplink.tools.ejb11.BeanInformationDefinition

loadProperties, topLink_CMP_DTD

Methods inherited from class java.lang.Object

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

Field Detail

SYNCHRONOUS

public static final java.lang.String SYNCHRONOUS

See Also:

Constant Field Values

ASYNCHRONOUS

public static final java.lang.String ASYNCHRONOUS

See Also:

Constant Field Values

DO_NOT_CHECK_CACHE

public static final java.lang.String DO_NOT_CHECK_CACHE

See Also:

Constant Field Values

CHECK_CACHE_BY_EXACT_PRIMARY_KEY

public static final java.lang.String CHECK_CACHE_BY_EXACT_PRIMARY_KEY

See Also:

Constant Field Values

CHECK_CACHE_BY_PRIMARY_KEY

public static final java.lang.String CHECK_CACHE_BY_PRIMARY_KEY

See Also:

Constant Field Values

CHECK_CACHE_THEN_DATABASE

public static final java.lang.String CHECK_CACHE_THEN_DATABASE

See Also:

Constant Field Values

CHECK_CACHE_ONLY

public static final java.lang.String CHECK_CACHE_ONLY

See Also:

Constant Field Values

CONFORM_RESULTS_IN_UNIT_OF_WORK

public static final java.lang.String CONFORM_RESULTS_IN_UNIT_OF_WORK

See Also:

Constant Field Values

TI_TRANSACTION_NONE

public static final java.lang.String TI_TRANSACTION_NONE

See Also:

Constant Field Values

TI_TRANSACTION_READ_UNCOMMITTED

public static final java.lang.String TI_TRANSACTION_READ_UNCOMMITTED

See Also:

Constant Field Values

TI_TRANSACTION_READ_COMMITTED

public static final java.lang.String TI_TRANSACTION_READ_COMMITTED

See Also:

Constant Field Values

TI_TRANSACTION_REPEATABLE_READ

public static final java.lang.String TI_TRANSACTION_REPEATABLE_READ

See Also:

Constant Field Values

TI_TRANSACTION_SERIALIZABLE

public static final java.lang.String TI_TRANSACTION_SERIALIZABLE

See Also:

Constant Field Values

Constructor Detail

CMPBeanDefinition

public CMPBeanDefinition()

CMPBeanDefinition

public CMPBeanDefinition(java.lang.String beanName)

CMPBeanDefinition

public CMPBeanDefinition(org.w3c.dom.Element beanElem)

Method Detail

addFinder

public void addFinder(FinderDefinition finder)

getBeanProperties

public java.util.Properties getBeanProperties()

getBeanProperty

public java.lang.String getBeanProperty(java.lang.String tagName)

getCacheUsage

public java.lang.String getCacheUsage()

Return the String that represents the cache usage level for queries. See static constants for possible values. Return null if none was specified.

getCustomizationClassName

public java.lang.String getCustomizationClassName()

getEjbName

public java.lang.String getEjbName()

getFinder

public FinderDefinition getFinder(java.lang.String finderName)

getFinderList

public java.util.Hashtable getFinderList()

getJdbcLevel

public java.lang.String getJdbcLevel()

Deprecated.

getLogDestination

public java.lang.String getLogDestination()

getLogMessages

public boolean getLogMessages()

getProject

public ProjectDefinition getProject()

getProjectClassName

public java.lang.String getProjectClassName()

getProjectDataSource

public java.lang.String getProjectDataSource()

getProjectFileName

public java.lang.String getProjectFileName()

getProjectIdentifier

public java.lang.String getProjectIdentifier()

getProjectPlatform

public java.lang.String getProjectPlatform()

getProjectPoolName

public java.lang.String getProjectPoolName()

getProjectReadOnlyDataSource

public java.lang.String getProjectReadOnlyDataSource()

getReadOnly

public java.lang.Boolean getReadOnly()

Return the Boolean object that contains true if the read-only attribute has been set to true, or false if it has been set to false. Return null if it has not been set.

getRefreshCache

public java.lang.Boolean getRefreshCache()

Return the Boolean object that contains true if the refresh cache option for finders has been set to true, or false if it has been set to false. Return null if it has not been set.

getTransactionIsolation

public java.lang.String getTransactionIsolation()

getUpdatePropagation

public java.lang.String getUpdatePropagation()

initializeBeanPropertiesElement

public void initializeBeanPropertiesElement()

intValueFromCacheUsageString

public static int intValueFromCacheUsageString(java.lang.String cacheUsageString)
                                        throws DeploymentException

Throws:

DeploymentException

intValueFromTxnIsolationString

public static int intValueFromTxnIsolationString(java.lang.String txnIsolationString)
                                          throws DeploymentException

Throws:

DeploymentException

intValueFromUpdatePropagationString

public static int intValueFromUpdatePropagationString(java.lang.String updatePropagationString)
                                               throws DeploymentException

Throws:

DeploymentException

loadProperties

public void loadProperties()

Precondition: The beanElement has been correctly initialized.

Overrides:

loadProperties in class BeanInformationDefinition

setBeanElement

public void setBeanElement(org.w3c.dom.Element newValue)

setBeanPropertiesElement

public void setBeanPropertiesElement(org.w3c.dom.Element newValue)

setCacheUsage

public void setCacheUsage(java.lang.String cacheUsageString)

Set the cache usage level for finders. This may be any one of the static constants defined in this class. This option is not required to be set.

setEJBName

public void setEJBName(java.lang.String ejbName)

setFinderList

public void setFinderList(java.util.Hashtable finderList)

setProject

public void setProject(ProjectDefinition newValue)

setReadOnly

public void setReadOnly(java.lang.Boolean readOnlyFlag)

Set the read-only attribute for this bean.

setRefreshCache

public void setRefreshCache(java.lang.Boolean refreshFlag)

Set the refresh cache option for finders. If set to TRUE then finders (unless overridden by the a particular finder) will refresh the cache with their results.

storeProperties

public org.w3c.dom.Document storeProperties()