org.apache.ojb.broker.metadata
Class ObjectCacheDescriptor

java.lang.Object
  org.apache.ojb.broker.metadata.ObjectCacheDescriptor

All Implemented Interfaces:

java.io.Serializable, AttributeContainer, RepositoryElements, XmlCapable

public class ObjectCacheDescriptor
extends java.lang.Object
implements java.io.Serializable, XmlCapable, AttributeContainer

Encapsulates a ObjectCache implementation class and its proprietary configuration properties.
All ObjectCache implementation specific configuration attributes are represented by key/value pairs in a Properties object and could be reached via getConfigurationProperties() or getAttribute(String key).

Version:

$Id: ObjectCacheDescriptor.java 364787 2005-04-26 03:41:37Z mkalen $

Author:

Armin Waibel

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.ojb.broker.metadata.RepositoryElements

_NEXT, ACCEPT_LOCKS, ACCESS, ATTRIBUTE, ATTRIBUTE_NAME, ATTRIBUTE_VALUE, AUTO_DELETE, AUTO_INCREMENT, AUTO_RETRIEVE, AUTO_UPDATE, BATCH_MODE, CASCADE_LINK_STR, CASCADE_NONE_STR, CASCADE_OBJECT_STR, CLASS_DESCRIPTOR, CLASS_EXTENT, CLASS_NAME, CLASS_PROXY, CLASS_REF, COLLECTION_CLASS, COLLECTION_DESCRIPTOR, COLUMN_NAME, CON_LOG_ABANDONED, CON_MAX_ACTIVE, CON_MAX_IDLE, CON_MAX_WAIT, CON_MIN_EVICTABLE_IDLE_TIME_MILLIS, CON_NUM_TESTS_PER_EVICTION_RUN, CON_REMOVE_ABANDONED, CON_REMOVE_ABANDONED_TIMEOUT, CON_TEST_ON_BORROW, CON_TEST_ON_RETURN, CON_TEST_WHILE_IDLE, CON_TIME_BETWEEN_EVICTION_RUNS_MILLIS, CON_WHEN_EXHAUSTED_ACTION, CONNECTION_FACTORY, CONNECTION_POOL, CONSTANT_ARGUMENT, DATASOURCE_NAME, DBMS_NAME, DEFAULT_CONNECTION, DELETE_PROCEDURE, DOCUMENTATION, DRIVER_NAME, EAGER_RELEASE, EXTENDS, FACTORY_CLASS, FACTORY_METHOD, FIELD_CONVERSION, FIELD_DESCRIPTOR, FIELD_ID_REF, FIELD_NAME, FIELD_REF, FK_POINTING_TO_ITEMS_CLASS, FK_POINTING_TO_THIS_CLASS, FOREIGN_KEY, ID, IGNORE_AUTOCOMMIT_EXCEPTION, INCLUDE_ALL_FIELDS, INCLUDE_PK_FIELDS_ONLY, INDEX_COLUMN, INDEX_DESCRIPTOR, INDEXED, INDIRECTION_TABLE, INITIALIZATION_METHOD, INSERT_PROCEDURE, INVERSE_FK, ISOLATION_LEVEL, ITEMS_CLASS, JCD_ALIAS, JDBC_CONNECTION_DESCRIPTOR, JDBC_LEVEL, JDBC_TYPE, LENGTH, LOCKING, MAPPING_REPOSITORY, NAME, NULLABLE, OBJECT_CACHE, ORDERBY, OTM_DEPENDENT, PRECISION, PRIMARY_KEY, PROXY_PREFETCHING_LIMIT, PROXY_REFERENCE, QUERY_CUSTOMIZER, REFERENCE_DESCRIPTOR, REFERENCED_CLASS, REFRESH, REPOSITORY_VERSION, RETURN, RETURN_FIELD_REF, ROW_READER, RUNTIME_ARGUMENT, SCALE, SCHEMA_NAME, SEQUENCE_MANAGER, SEQUENCE_MANAGER_CLASS, SEQUENCE_NAME, SORT, TABLE_NAME, TAG_ACCESS, TAG_ACCESS_ANONYMOUS, TAG_ACCESS_READONLY, TAG_ACCESS_READWRITE, TAG_SUPER, UNIQUE, UPDATE_LOCK, UPDATE_PROCEDURE, URL_DBALIAS, URL_PROTOCOL, URL_SUBPROTOCOL, USE_AUTOCOMMIT, USER_NAME, USER_PASSWD, VALIDATION_QUERY, VALUE

Constructor Summary

ObjectCacheDescriptor()

ObjectCacheDescriptor(java.lang.Class objectCacheClass)

Method Summary

void	addAttribute(java.lang.String attributeName, java.lang.String attributeValue) Store the specified attribute and it's value.
java.lang.String	getAttribute(java.lang.String key) Get the value of an attribute
java.lang.String	getAttribute(java.lang.String attributeName, java.lang.String defaultValue) Get the value of an attribute
java.util.Properties	getConfigurationProperties()
java.lang.Class	getObjectCache()
void	setConfigurationProperties(java.util.Properties configurationProperties)
void	setObjectCache(java.lang.Class objectCache)
java.lang.String	toString()
java.lang.String	toXML() returns the XML marshalled version of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectCacheDescriptor

public ObjectCacheDescriptor()

ObjectCacheDescriptor

public ObjectCacheDescriptor(java.lang.Class objectCacheClass)

Method Detail

getObjectCache

public java.lang.Class getObjectCache()

setObjectCache

public void setObjectCache(java.lang.Class objectCache)

addAttribute

public void addAttribute(java.lang.String attributeName,
                         java.lang.String attributeValue)

Description copied from interface: AttributeContainer

Store the specified attribute and it's value.

Specified by:

addAttribute in interface AttributeContainer

Parameters:

attributeName - the name of the attribute to retrieve

attributeValue - the attribute's value

getAttribute

public java.lang.String getAttribute(java.lang.String key)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

key - the attribute to retrieve

Returns:

the attribute value

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName,
                                     java.lang.String defaultValue)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

attributeName - the attribute to retrieve

defaultValue - the value to return if the attribute is not present

Returns:

the attribute value

getConfigurationProperties

public java.util.Properties getConfigurationProperties()

setConfigurationProperties

public void setConfigurationProperties(java.util.Properties configurationProperties)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXML

public java.lang.String toXML()

Description copied from interface: XmlCapable

returns the XML marshalled version of this instance.

Specified by:

toXML in interface XmlCapable

Returns:

the XML String representing this object.