org.protempa.bconfigs.ini4j

Class INIConfigurations

java.lang.Object

org.protempa.backend.AbstractConfigurations

org.protempa.bconfigs.ini4j.INIConfigurations

All Implemented Interfaces:

org.protempa.backend.Configurations

public class INIConfigurations
extends org.protempa.backend.AbstractConfigurations

Implements configurations for Protempa using INI files. A configuration id is the name of an INI file that is in a directory specified in the constructor.

Author:

Andrew Post

Field Summary

Fields

Modifier and Type	Field and Description
static File	DEFAULT_DIRECTORY The default directory for configurations (.protempa-configs in the user's home directory).
static String	DIRECTORY_SYSTEM_PROPERTY The name of the system property ( protempa.inicommonsconfigurations.pathname) for specifying the configuration file directory.

Constructor Summary

Constructors

Constructor and Description
INIConfigurations() Creates an INI file configurations instance.
INIConfigurations(org.protempa.backend.BackendProvider backendProvider, File directory) Creates an INI file configurations instance that looks for configuration files in the specified directory.
INIConfigurations(File pathname) Creates an INI file configurations instance that looks for backend configurations in the specified directory.

Method Summary

Modifier and Type	Method and Description
File	getDirectory() Returns the directory in which configuration files are expected to be found.
org.protempa.backend.Configuration	load(String configurationId)
void	remove(String configurationId)
void	save(org.protempa.backend.Configuration configuration)

Methods inherited from class org.protempa.backend.AbstractConfigurations

getBackendProvider, newAlgorithmSourceBackendSection, newDataSourceBackendSection, newKnowledgeSourceBackendSection, newTermSourceBackendSection

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIRECTORY

public static final File DEFAULT_DIRECTORY

The default directory for configurations (.protempa-configs in the user's home directory).

DIRECTORY_SYSTEM_PROPERTY

public static final String DIRECTORY_SYSTEM_PROPERTY

The name of the system property ( protempa.inicommonsconfigurations.pathname) for specifying the configuration file directory.

See Also:

Constant Field Values

Constructor Detail

INIConfigurations

public INIConfigurations()

Creates an INI file configurations instance. Using this constructor is equivalent to specifying a pathname of null in the one-argument constructor.

INIConfigurations

public INIConfigurations(File pathname)

Creates an INI file configurations instance that looks for backend configurations in the specified directory. If null, the default directory will be used (DEFAULT_DIRECTORY).

Parameters:

pathname - the directory containing backend configurations.

INIConfigurations

public INIConfigurations(org.protempa.backend.BackendProvider backendProvider,
                         File directory)

Creates an INI file configurations instance that looks for configuration files in the specified directory. If null, it first looks for a system property, protempa.inicommonsconfigurations.pathname for a pathname. If unspecified, it looks for configuration files in the default location (see DEFAULT_DIRECTORY).

Parameters:

backendProvider - the provider for loading data source, knowledge source, algorithm source etc. backends.

directory - the directory containing backend configuration files.

Method Detail

getDirectory

public File getDirectory()

Returns the directory in which configuration files are expected to be found.

Returns:

a directory File.

load

public org.protempa.backend.Configuration load(String configurationId)
                                        throws org.protempa.backend.ConfigurationsLoadException,
                                               org.protempa.backend.ConfigurationsNotFoundException

Throws:

org.protempa.backend.ConfigurationsLoadException

org.protempa.backend.ConfigurationsNotFoundException

save

public void save(org.protempa.backend.Configuration configuration)
          throws org.protempa.backend.ConfigurationsSaveException

Throws:

org.protempa.backend.ConfigurationsSaveException

remove

public void remove(String configurationId)
            throws org.protempa.backend.ConfigurationRemoveException

Throws:

org.protempa.backend.ConfigurationRemoveException