de.softdevel.d1.datapool

Interface IDatapool

public interface IDatapool

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.String aPath, java.lang.String aKey, ITargetAddress aObserver) Add a listener for a data pool slot.
void	addOrUpdateRecord(IDatapoolRecord aRecord, boolean aForce) Add a new record to the pool.
void	disableNotifications() Disable all listener notifications.
void	dumpValues(org.slf4j.Logger aLogger) Dump all datapool values to a logger.
void	enableNotifications(INamespace aNamespace) Enable all listener notifications.
int	getCount() Get the number of records over all namespaces.
int	getCount(java.lang.String aPath) Get the number of records for a single namespace.
java.util.Collection<java.lang.String>	getDump() Dump the content of the datapool to a String list.
java.util.Collection<java.lang.String>	getKeys(java.lang.String aPath)
java.lang.String	getName()
char	getPathDelimiter()
java.util.Collection<IDatapoolRecord>	getRecords(java.lang.String aPath)
java.util.Collection<java.lang.String>	getSubDirectories(java.lang.String aPath) Get all sub directories to a path.
java.util.Collection<IDatapoolRecord>	getSubRecords(java.lang.String aPath)
java.lang.String	getValue(java.lang.String aPath, java.lang.String aKey) Get a value from the data pool.
java.lang.String	getValue(java.lang.String aPath, java.lang.String aKey, java.lang.String aDefaultValue) Get a value from the data pool.
CResult	importConfigFile(java.lang.String aPath) Import a configuration file in XML format.
void	importXml(java.io.File aFile)
boolean	isNotificationEnabled()
void	remove(java.lang.String aPath)
void	remove(java.lang.String aPath, java.lang.String aKey) Remove a datapool slot.
void	removeListener(java.lang.String aPath, java.lang.String aKey, ITargetAddress aObserver) Add a listener for a data pool slot.
void	setValue(java.lang.String aPath, java.lang.String aKey, java.lang.String aValue) Add or update a value in the pool.

Method Detail

addListener

void addListener(java.lang.String aPath,
                 java.lang.String aKey,
                 ITargetAddress aObserver)
          throws CException

Add a listener for a data pool slot.

Parameters:

aPath - A datapool path.

aKey - The key.

aObserver - The observer target address.

Throws:

CException - if key is not valid (Type or ID).

addOrUpdateRecord

void addOrUpdateRecord(IDatapoolRecord aRecord,
                       boolean aForce)

Add a new record to the pool.

Parameters:

aRecord - The datapool record.

aForce - True = data will be overwritten in database, if record exists. False = data will NOT be overwritten, if record exists.

disableNotifications

void disableNotifications()

Disable all listener notifications. Useful on initial fill.

dumpValues

void dumpValues(org.slf4j.Logger aLogger)

Dump all datapool values to a logger.

Parameters:

aLogger - The logger used to dump all datapool values.

enableNotifications

void enableNotifications(INamespace aNamespace)
                  throws CException

Enable all listener notifications.

Parameters:

aNamespace - The namespace where the notification handler is registered in.

Throws:

CException - on error registering the target.

getCount

int getCount()

Get the number of records over all namespaces.

Returns:

The number of records over all namespaces.

getCount

int getCount(java.lang.String aPath)

Get the number of records for a single namespace.

Parameters:

aPath - The path to count the records for.

Returns:

The number of records for a single namespace.

getDump

java.util.Collection<java.lang.String> getDump()

Dump the content of the datapool to a String list.

Returns:

A list of Strings which can be used to make a dump on log.

getKeys

java.util.Collection<java.lang.String> getKeys(java.lang.String aPath)

Parameters:

aPath - The path for the keys.

Returns:

The list of keys (never null).

getName

java.lang.String getName()

Returns:

The name of the datapool.

getPathDelimiter

char getPathDelimiter()

Returns:

The path delimiter character (a slash, '/').

getRecords

java.util.Collection<IDatapoolRecord> getRecords(java.lang.String aPath)

Parameters:

aPath - A data pool path.

Returns:

A list of records for that path.

getSubDirectories

java.util.Collection<java.lang.String> getSubDirectories(java.lang.String aPath)

Get all sub directories to a path.

Parameters:

aPath - The path.

Returns:

A collection of sub directories.

getSubRecords

java.util.Collection<IDatapoolRecord> getSubRecords(java.lang.String aPath)

Parameters:

aPath - A data pool path.

Returns:

A list of records where the path starts with that part of the path.

getValue

java.lang.String getValue(java.lang.String aPath,
                          java.lang.String aKey)

Get a value from the data pool.

Parameters:

aPath - A datapool path.

aKey - The slot key.

Returns:

The value if found, otherwise null.

getValue

java.lang.String getValue(java.lang.String aPath,
                          java.lang.String aKey,
                          java.lang.String aDefaultValue)

Get a value from the data pool.

Parameters:

aPath - A datapool path.

aKey - The slot key.

aDefaultValue - The default value.

Returns:

The value if found, otherwise the default value.

importConfigFile

CResult importConfigFile(java.lang.String aPath)

Import a configuration file in XML format.

Parameters:

aPath - The path of the file.

Returns:

Result on error, otherwise null.

importXml

void importXml(java.io.File aFile)
        throws CException

Parameters:

aFile - The XML file.

Throws:

CException - on error.

isNotificationEnabled

boolean isNotificationEnabled()

Returns:

True = listener will be informed by slot changes.

remove

void remove(java.lang.String aPath)

Parameters:

aPath - The path (and all sub entries) will be deleted.

remove

void remove(java.lang.String aPath,
            java.lang.String aKey)

Remove a datapool slot.

Parameters:

aPath - A datapool path.

aKey - The slot key.

removeListener

void removeListener(java.lang.String aPath,
                    java.lang.String aKey,
                    ITargetAddress aObserver)
             throws CException

Add a listener for a data pool slot.

Parameters:

aPath - A datapool path.

aKey - The key.

aObserver - The observer target address.

Throws:

CException - if key is invalid (type or ID).

setValue

void setValue(java.lang.String aPath,
              java.lang.String aKey,
              java.lang.String aValue)

Add or update a value in the pool.

Parameters:

aPath - The path of the record.

aKey - The key of the record.

aValue - The value of the record.