org.norther.tammi.root.castor
Interface XMLPersisterFactory

All Superinterfaces:

CacheClient, Configurable, ConfigurableFactory, KeyCacheClient, ObjectFactory, PersisterFactory, Refreshable, Startable

All Known Implementing Classes:

DefaultXMLPersisterFactory

public interface XMLPersisterFactory
extends PersisterFactory, Startable

An interface to XML specific Persister factories. The corresponding Persister implementation is XMLPersister.

The XML configuration is loaded from a property file by using the following syntax:

 ##
 # One or more repsitory connection keys.
 # connection.key = 'key'
 connection.key = root
 ##
 # The default key to apply.
 # default.key = 'key'
 default.key = root
 ##
 # The path to the XML mapping file.
 # 'key'.mapping = 'path'
 root.mapping = tammi/root/castormapping.xml
 ##
 # The path to the XML repository record.
 # 'key'.repository = 'path'
 root.repository = tammi/root/castorrepository.rxml
 ##
 # The initial capacity of the repository.
 # 'key'.capacity = 'capacity'
 ##
 # The record length of the repository.
 # 'key'.record.length = 'reclen'
 

Author:

Ilkka Priha

Field Summary

static String	CAPACITY_PROPERTY_SUFFIX The capacity property suffix.
static String	CONNECTION_KEY_PROPERTY The connection key property.
static String	DEFAULT_KEY_PROPERTY The default key property.
static String	MAPPING_PROPERTY_SUFFIX The mapping property suffix.
static String	RECORD_LENGTH_PROPERTY_SUFFIX The record length property suffix.
static String	REPOSITORY_PROPERTY_SUFFIX The repository property suffix.

Fields inherited from interface org.norther.tammi.root.db.PersisterFactory

ANY_ALIAS, EXT_BASE_CLASS_NAME, EXT_BEGIN_CLASS, EXT_BEGIN_FIELD, EXT_BLANK_ACCEPTED, EXT_CLONEABLE, EXT_COLLECTION, EXT_COMPARATOR_CLASS_NAME, EXT_CORRELATIVE, EXT_DESCENDING, EXT_DESCRIPTION, EXT_DETAIL, EXT_DISABLED, EXT_EMPTY_ACCEPTED, EXT_END_CLASS, EXT_END_FIELD, EXT_ENUM_NAME, EXT_ENUM_VALUE, EXT_ENUMERATED, EXT_EXPORTER_CLASS_NAME, EXT_GROUP, EXT_IMPORTER_CLASS_NAME, EXT_INDEX, EXT_INTERACTIVE, EXT_LOCAL, EXT_LOCALIZED, EXT_MANDATORY, EXT_MAX_VALUE, EXT_MIN_VALUE, EXT_NAME_PATTERN, EXT_OPTIONS, EXT_ORDER_BY, EXT_ORDERED, EXT_PATTERN, EXT_PRIMARY, EXT_READABLE, EXT_REFERENCE, EXT_SERIALIZED, EXT_SHADOW, EXT_SORTED, EXT_TRACEABLE, EXT_TRANSIENT, EXT_TRIMMED, EXT_TYPE, EXT_VALIDATOR_CLASS_NAME, EXT_VALUE, EXT_VISIBLE, EXT_WRITABLE, JDBC_TYPE_PROPERTY

Method Summary

String	getDefaultConnectionKey() Gets the key of the default connection.
void	setDefaultConnectionKey(String key) Sets the key of the default connection.

Methods inherited from interface org.norther.tammi.root.db.PersisterFactory

addClassDescriptor, addClassDescriptor, addClassDescriptor, clearClassDescriptors, clearConnectionDescriptors, containsClassDescriptor, containsConnectionDescriptor, getAttributeType, getConnectionDTD, getConnectionURL, getConnectionUsername, getLastModified, getRepositoryDTD, getVariableRegistryName, isCombinedFactoryCache, isRefreshReferencesEnabled, isTraceReferencesDisabled, jdbcTypeSet, query, query, removeAttributeType, removeConnectionDescriptor, removeConnectionDescriptor, setAttributeType, setCombinedFactoryCache, setConnectionDescriptor, setConnectionDescriptor, setConnectionDTD, setConnectionPassword, setConnectionURL, setConnectionUsername, setDefaultConnectionKey, setRefreshReferencesEnabled, setRepositoryDTD, setTraceReferencesDisabled, setVariableRegistryName

Methods inherited from interface org.norther.tammi.core.base.ObjectFactory

getInstance, getInstance, getInstance, getInstance, isLoaderSupported

Methods inherited from interface org.norther.tammi.core.config.Configurable

addProperty, addProperty, clearProperties, containsProperty, getConfigKey, getProperties, getProperty, getPropertyFilePath, indexOfProperty, propertyMap, propertyMap, removeProperty, removeProperty, setConfigKey, setProperties, setProperty, setPropertyFilePath, setPropertyFilePath, storeProperties

Methods inherited from interface org.norther.tammi.core.cache.KeyCacheClient

cacheKeySet, clearCaches, getCache, removeCache

Methods inherited from interface org.norther.tammi.core.cache.CacheClient

clearCached, expireCached, expireFraction, getCache, isCachingDisabled, removeCache, setCachingDisabled

Methods inherited from interface org.norther.tammi.core.base.Refreshable

getRefreshed, refresh

Methods inherited from interface org.norther.tammi.core.base.Startable

isStarted, start, stop

Field Detail

CONNECTION_KEY_PROPERTY

static final String CONNECTION_KEY_PROPERTY

The connection key property.

See Also:

Constant Field Values

DEFAULT_KEY_PROPERTY

static final String DEFAULT_KEY_PROPERTY

The default key property.

See Also:

Constant Field Values

MAPPING_PROPERTY_SUFFIX

static final String MAPPING_PROPERTY_SUFFIX

The mapping property suffix.

See Also:

Constant Field Values

REPOSITORY_PROPERTY_SUFFIX

static final String REPOSITORY_PROPERTY_SUFFIX

The repository property suffix.

See Also:

Constant Field Values

CAPACITY_PROPERTY_SUFFIX

static final String CAPACITY_PROPERTY_SUFFIX

The capacity property suffix.

See Also:

Constant Field Values

RECORD_LENGTH_PROPERTY_SUFFIX

static final String RECORD_LENGTH_PROPERTY_SUFFIX

The record length property suffix.

See Also:

Constant Field Values

Method Detail

getDefaultConnectionKey

String getDefaultConnectionKey()

Gets the key of the default connection.

Specified by:

getDefaultConnectionKey in interface PersisterFactory

Returns:

the key of the default connection.

setDefaultConnectionKey

void setDefaultConnectionKey(String key)

Sets the key of the default connection.

Specified by:

setDefaultConnectionKey in interface PersisterFactory

Parameters:

key - the key of the default connection.