|
SolarMetric Kodo JDO 2.4.3 generated on March 27 2003 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Configuration defines the properties necessary to configure runtime properties and connect to a data source.
Any property names ending in Properties can be used to
configure the object they pertain to using a simple properties-style string.
For example, if the set DataCacheClass has methods
setMaxSize(int) and setRemoteHost(String,int),
then these properties can be set using a DataCacheProperties
string like:
maxSize=500 remoteHost=cacheserver.xyz.com,8080
The following is a list of recognized properties:
All setter methods that take primitive parameters also have wrapper setters with the appropriate primitive wrapper. This is so the Configuration interface can be in accordance with the J2EE Connection Architecture.
| Field Summary | |
|---|---|
static String |
LOG_CACHE
|
static String |
LOG_CONF
|
static String |
LOG_ENHANCE
|
static String |
LOG_METADATA
|
static String |
LOG_QUERY
|
static String |
LOG_RUNTIME
|
| Fields inherited from interface java.beans.BeanInfo |
|---|
ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 |
| Method Summary | |
|---|---|
Object |
clone()
Returns a clone of this Configuration. |
Configuration |
configurationClone()
Return a new Configuration that is an exact copy of this one. |
void |
freeze()
Freeze this Configuration; if frozen, calls to #checkFrozen will throw a JDOUserException. |
void |
fromProperties(Properties properties)
Set this Configuration via the given Properties. |
int |
getCacheReferenceSize()
Returns the number of hard references to objects that the PersistenceManager's cache will retain. |
String |
getConnectionDriverName()
Class name of the Connection Driver. |
Object |
getConnectionFactory()
The connection factory, possibly from JNDI. |
Object |
getConnectionFactory2()
The connection factory, possibly from JNDI. |
String |
getConnectionFactory2Name()
The name for the second data store connection factory. |
String |
getConnectionFactoryName()
The name for the data store connection factory. |
String |
getConnectionPassword()
The password for the data store connection. |
String |
getConnectionProperties()
Get the properties string to apply to the connection factory. |
Properties |
getConnectionPropertiesProps()
Returns the ConnectionFactory properties as a Properties
object. |
String |
getConnectionURL()
The URL for the data store connection. |
String |
getConnectionUserName()
The user name for the data store connection. |
DataCache |
getDataCache()
The L2 data cache. |
String |
getDataCacheClass()
The class to use for level-2 data store caching. |
String |
getDataCacheProperties()
Configuration options for the data cache. |
int |
getDefaultFetchBatchSize()
Get the size of the batch that will be pre-selected when accessing elements in a Query result. |
int |
getDefaultFetchThreshold()
Get the threshold below which result lists will be completely instantiated upon theircreation. |
boolean |
getEnableQueryExtensions()
Allow filter extensions to be used |
boolean |
getIgnoreCache()
The default IgnoreCache setting for all PersistenceManager instances obtained from this factory. |
String |
getLicenseKey()
The runtime license key for Kodo. |
int |
getMaxPool()
The maximum number of connections in the connection pool. |
int |
getMinPool()
The minimum number of connections in the connection pool. |
int |
getMsWait()
The number of milliseconds to wait for an available connection from the connection pool before throwing a JDODatastoreException. |
boolean |
getMultithreaded()
The default Multithreaded setting for all PersistenceManager instances obtained from this factory. |
boolean |
getNontransactionalRead()
The default NontransactionalRead setting for all PersistenceManager instances obtained from this factory. |
boolean |
getNontransactionalWrite()
The default NontransactionalWrite setting for all PersistenceManager instances obtained from this factory. |
boolean |
getOptimistic()
The default Optimistic setting for all PersistenceManager instances obtained from this factory. |
String |
getPersistenceManagerClass()
The class name of the PersistenceManager
type to create. |
String |
getPersistenceManagerFactoryClass()
Class name of the PersistenceManagerFactoryClass implementation |
String |
getPersistenceManagerProperties()
Configuration options for the persistence manager. |
String[] |
getPersistentTypeNames()
Returns an array of names of the persistent types in the PersistentTypes property, or null if no types were listed in the property. |
String |
getPersistentTypes()
Returns a list of persistent types that are to be registered every time a PersistenceManager is obtained from
a PersistenceManagerFactory. |
ProxyManager |
getProxyManager()
The proxy manager. |
String |
getProxyManagerClass()
The manager for second class object proxies. |
String |
getProxyManagerProperties()
Configuration for the proxy manager. |
String |
getQueryFilterListeners()
set the FilterListeners properties |
boolean |
getRestoreValues()
The default RestoreValues setting for all PersistenceManager instances obtained from this factory. |
boolean |
getRetainValues()
The default RetainValues setting for all PersistenceManager instances obtained from this factory. |
boolean |
getUseSoftTransactionCache()
Return true if the PersistenceManager
should maintain soft references to objects in the
transactional cache. |
boolean |
isFrozen()
Return true if this Configuration has been frozen. |
void |
setCacheReferenceSize(int size)
Set the number of hard references to objects that the PersistenceManager's cache will retain. |
void |
setCacheReferenceSize(Integer size)
Wrapper setter for setCacheReferenceSize(int). |
void |
setConnectionDriverName(String driverName)
Class name of the Connection Driver. |
void |
setConnectionFactory(Object factory)
The connection factory. |
void |
setConnectionFactory2(Object factory)
The connection factory. |
void |
setConnectionFactory2Name(String cf2Name)
The name for the second data store connection factory. |
void |
setConnectionFactoryName(String cfName)
The name for the data store connection factory. |
void |
setConnectionPassword(String connectionPassword)
The password for the data store connection. |
void |
setConnectionProperties(String connectionProperties)
Set the properties string to apply to the connection factory. |
void |
setConnectionURL(String connectionURL)
The URL for the data store connection. |
void |
setConnectionUserName(String connectionUserName)
The user name for the data store connection. |
void |
setDataCache(DataCache cache)
The L2 data cache. |
void |
setDataCacheClass(String dataCacheClass)
The class to use for level-2 data store caching. |
void |
setDataCacheProperties(String props)
Configuration options for the data cache. |
void |
setDefaultFetchBatchSize(int size)
Set the size of the batch that will be pre-selected when accessing elements in a Query result. |
void |
setDefaultFetchBatchSize(Integer size)
Wrapper setter for setDefaultFetchBatchSize(int). |
void |
setDefaultFetchThreshold(int threshold)
Set the threshold below which result lists will be completely instantiated upon their creation. |
void |
setDefaultFetchThreshold(Integer threshold)
Wrapper setter for setDefaultFetchThreshold(int). |
void |
setEnableQueryExtensions(boolean enable)
Set whether filter extensions can be used |
void |
setEnableQueryExtensions(Boolean enable)
Wrapper setter for setEnableQueryExtensions(boolean). |
void |
setIgnoreCache(boolean ignoreCache)
The default IgnoreCache setting for all PersistenceManager instances obtained from this factory. |
void |
setIgnoreCache(Boolean ignoreCache)
Wrapper setter for setIgnoreCache(boolean). |
void |
setLicenseKey(String licenseKey)
The runtime license key for Kodo. |
void |
setMaxPool(int maxPool)
The maximum number of connections in the connection pool. |
void |
setMaxPool(Integer maxPool)
Wrapper setter for setMaxPool(int). |
void |
setMinPool(int minPool)
The minimum number of connections in the connection pool. |
void |
setMinPool(Integer minPool)
Wrapper setter for setMinPool(int). |
void |
setMsWait(int msWait)
The number of milliseconds to wait for an available connection from the connection pool before throwing a JDODatastoreException. |
void |
setMsWait(Integer msWait)
Wrapper setter for setMsWait(int). |
void |
setMultithreaded(boolean multithreaded)
The default Multithreaded setting for all PersistenceManager instances obtained from this factory. |
void |
setMultithreaded(Boolean multithreaded)
Wrapper setter for setMultithreaded(boolean). |
void |
setNontransactionalRead(boolean ntRead)
The default NontransactionalRead setting for all PersistenceManager instances obtained from this factory. |
void |
setNontransactionalRead(Boolean ntRead)
Wrapper setter for setNontransactionalRead(boolean). |
void |
setNontransactionalWrite(boolean ntWrite)
The default NontransactionalWrite setting for all PersistenceManager instances obtained from this factory. |
void |
setNontransactionalWrite(Boolean ntWrite)
Wrapper setter for setNontransactionalWrite(boolean). |
void |
setOptimistic(boolean optimistic)
The default Optimistic setting for all PersistenceManager instances obtained from this factory. |
void |
setOptimistic(Boolean optimistic)
Wrapper setter for setOptimistic(boolean). |
void |
setPersistenceManagerClass(String pmClass)
The class name of the PersistenceManager
type to create. |
void |
setPersistenceManagerFactoryClass(String pmfName)
Class name of the PersistenceManagerFactoryClass implementation. |
void |
setPersistenceManagerProperties(String props)
Configuration options for the persistence manager. |
void |
setPersistentTypes(String types)
Sets a list of persistent types that are to be registered every time a PersistenceManager is obtained from
a PersistenceManagerFactory. |
void |
setProxyManager(ProxyManager manager)
The proxy manager. |
void |
setProxyManagerClass(String proxyClass)
The manager for second class object proxies. |
void |
setProxyManagerProperties(String props)
Configuration for the proxy manager. |
void |
setQueryFilterListeners(String props)
Set the FilterListeners config properties |
void |
setRestoreValues(boolean restoreValues)
The default RestoreValues setting for all PersistenceManager instances obtained from this factory. |
void |
setRestoreValues(Boolean restoreValues)
Wrapper setter for setRestoreValues(boolean). |
void |
setRetainValues(boolean retainValues)
The default RetainValues setting for all PersistenceManager instances obtained from this factory. |
void |
setRetainValues(Boolean retainValues)
Wrapper setter for setRetainValues(boolean). |
void |
setUseSoftTransactionCache(boolean val)
Set whether or not the PersistenceManager should
maintain soft references to objects in the transactional
cache. |
void |
setUseSoftTransactionCache(Boolean val)
Wrapper setter for setUseSoftTransactionCache(boolean). |
Properties |
toProperties()
A Properties representation of this Configuration. |
| Methods inherited from interface java.beans.BeanInfo |
|---|
getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getMethodDescriptors, getPropertyDescriptors |
| Field Detail |
public static final String LOG_METADATA
public static final String LOG_ENHANCE
public static final String LOG_QUERY
public static final String LOG_RUNTIME
public static final String LOG_CONF
public static final String LOG_CACHE
| Method Detail |
public String getLicenseKey()
public void setLicenseKey(String licenseKey)
public String getPersistenceManagerClass()
PersistenceManager
type to create.public void setPersistenceManagerClass(String pmClass)
PersistenceManager
type to create.public String getPersistenceManagerProperties()
public void setPersistenceManagerProperties(String props)
public String getDataCacheClass()
public void setDataCacheClass(String dataCacheClass)
public String getDataCacheProperties()
public void setDataCacheProperties(String props)
public DataCache getDataCache()
setDataCache(com.solarmetric.kodo.runtime.datacache.DataCache) method, it will be returned. Otherwise, if the
data cache class has been set, a new instance of the class will be
created and configured with any set data cache properties. This
instance will be cached for subsequent calls to this method. Finally,
if no data cache class is set, null is returned.public void setDataCache(DataCache cache)
setDataCacheClass(java.lang.String) and
setDataCacheProperties(java.lang.String). Note that the instance set will
be held transiently.public String getProxyManagerClass()
public void setProxyManagerClass(String proxyClass)
public String getProxyManagerProperties()
public void setProxyManagerProperties(String props)
public ProxyManager getProxyManager()
setProxyManager(com.solarmetric.kodo.util.ProxyManager) method, it will be returned. Otherwise, if the
data manager class has been set, a new instance of the class will be
created and configured with any set proxy manager properties. This
instance will be cached for subsequent calls to this method. Finally,
if no proxy manager class is set, null is returned.public void setProxyManager(ProxyManager manager)
setProxyManagerClass(java.lang.String) and
setProxyManagerProperties(java.lang.String). Note that the instance set will
be held transiently.public boolean getOptimistic()
public void setOptimistic(boolean optimistic)
public void setOptimistic(Boolean optimistic)
setOptimistic(boolean).public boolean getRetainValues()
public void setRetainValues(boolean retainValues)
public void setRetainValues(Boolean retainValues)
setRetainValues(boolean).public boolean getRestoreValues()
public void setRestoreValues(boolean restoreValues)
public void setRestoreValues(Boolean restoreValues)
setRestoreValues(boolean).public boolean getIgnoreCache()
public void setIgnoreCache(boolean ignoreCache)
public void setIgnoreCache(Boolean ignoreCache)
setIgnoreCache(boolean).public boolean getNontransactionalRead()
public void setNontransactionalRead(boolean ntRead)
public void setNontransactionalRead(Boolean ntRead)
setNontransactionalRead(boolean).public boolean getNontransactionalWrite()
public void setNontransactionalWrite(boolean ntWrite)
public void setNontransactionalWrite(Boolean ntWrite)
setNontransactionalWrite(boolean).public boolean getMultithreaded()
public void setMultithreaded(boolean multithreaded)
public void setMultithreaded(Boolean multithreaded)
setMultithreaded(boolean).public String getConnectionUserName()
public void setConnectionUserName(String connectionUserName)
public String getConnectionPassword()
public void setConnectionPassword(String connectionPassword)
public String getConnectionURL()
public void setConnectionURL(String connectionURL)
public String getConnectionDriverName()
public void setConnectionDriverName(String driverName)
public String getPersistenceManagerFactoryClass()
public void setPersistenceManagerFactoryClass(String pmfName)
public String getConnectionFactoryName()
public void setConnectionFactoryName(String cfName)
public Object getConnectionFactory()
public void setConnectionFactory(Object factory)
public String getConnectionFactory2Name()
public void setConnectionFactory2Name(String cf2Name)
public Object getConnectionFactory2()
public void setConnectionFactory2(Object factory)
public int getMaxPool()
public void setMaxPool(int maxPool)
public void setMaxPool(Integer maxPool)
setMaxPool(int).public int getMinPool()
public void setMinPool(int minPool)
public void setMinPool(Integer minPool)
setMinPool(int).public int getMsWait()
public void setMsWait(int msWait)
public void setMsWait(Integer msWait)
setMsWait(int).public int getDefaultFetchThreshold()
public void setDefaultFetchThreshold(int threshold)
public void setDefaultFetchThreshold(Integer threshold)
setDefaultFetchThreshold(int).public int getDefaultFetchBatchSize()
public void setDefaultFetchBatchSize(int size)
public void setDefaultFetchBatchSize(Integer size)
setDefaultFetchBatchSize(int).public String getQueryFilterListeners()
public void setQueryFilterListeners(String props)
public boolean getEnableQueryExtensions()
public void setEnableQueryExtensions(boolean enable)
public void setEnableQueryExtensions(Boolean enable)
setEnableQueryExtensions(boolean).public int getCacheReferenceSize()
PersistenceManager's cache will retain.
-1 to maintain hard refs to all objects in the
cache.public void setCacheReferenceSize(int size)
PersistenceManager's cache will retain.public void setCacheReferenceSize(Integer size)
setCacheReferenceSize(int).public void setUseSoftTransactionCache(boolean val)
PersistenceManager should
maintain soft references to objects in the transactional
cache.public void setUseSoftTransactionCache(Boolean val)
setUseSoftTransactionCache(boolean).public Properties getConnectionPropertiesProps()
Properties
object.public void setConnectionProperties(String connectionProperties)
public String getConnectionProperties()
public void setPersistentTypes(String types)
PersistenceManager is obtained from
a PersistenceManagerFactory.public String getPersistentTypes()
PersistenceManager is obtained from
a PersistenceManagerFactory.public String[] getPersistentTypeNames()
getPersistentTypes()public boolean getUseSoftTransactionCache()
true if the PersistenceManager
should maintain soft references to objects in the
transactional cache.public void freeze()
#checkFrozen will throw a JDOUserException.public boolean isFrozen()
public Properties toProperties()
public void fromProperties(Properties properties)
public Configuration configurationClone()
public Object clone()
clone in class Object
|
SolarMetric Kodo JDO 2.4.3 generated on March 27 2003 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||