loci.tests.testng

Class ConfigurationTree

java.lang.Object

loci.tests.testng.ConfigurationTree

public class ConfigurationTree
extends Object

Stores configuration data about files in a directory structure. This class is not designed to be thread safe, so should be synchronized externally for proper thread safety.

Field Summary

Fields

Modifier and Type	Field and Description
private String	configDir Base directory on the file system associated with the configuration files.
private static org.slf4j.Logger	LOGGER
private DefaultMutableTreeNode	root Root of tree structure containing configuration data.
private String	rootDir Directory on the file system associated with the tree root.

Constructor Summary

Constructors

Constructor and Description
ConfigurationTree(String rootDir) Constructs a new configuration tree rooted at the given directory in the file system.
ConfigurationTree(String rootDir, String configDir) Constructs a new configuration tree rooted at the given directory in the file system with a custom configuration directory.

Method Summary

Methods

Modifier and Type	Method and Description
private DefaultMutableTreeNode	findNode(String id, boolean create, String configFile) Gets the tree node associated with the given file.
Configuration	get(String id) Retrieves the Configuration object corresponding to the given file.
String	getConfigDirectory() Returns the base directory holding the configuration files
String	getRootDirectory() Returns the toot directory holding the data
void	parseConfigFile(String configFile)
String	relocate(String path, String oldRoot, String newRoot) Relocate a path from an base directory into a target directory
String	relocateToConfig(String path) Relocate a path under the root directory to the configuration directory
String	relocateToRoot(String path) Relocate a path under the configuration directory to the root directory

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

rootDir

private String rootDir

Directory on the file system associated with the tree root.

configDir

private String configDir

Base directory on the file system associated with the configuration files.

root

private DefaultMutableTreeNode root

Root of tree structure containing configuration data. Each node's user object is a hashtable of key/value pairs.

Constructor Detail

ConfigurationTree

public ConfigurationTree(String rootDir)

Constructs a new configuration tree rooted at the given directory in the file system.

Parameters:

rootDir - a string specifying the root directory

ConfigurationTree

public ConfigurationTree(String rootDir,
                 String configDir)

Constructs a new configuration tree rooted at the given directory in the file system with a custom configuration directory.

Parameters:

rootDir - a string specifying the root directory

configDir - a string specifying the base configuration directory

Method Detail

getRootDirectory

public String getRootDirectory()

Returns the toot directory holding the data

getConfigDirectory

public String getConfigDirectory()

Returns the base directory holding the configuration files

relocate

public String relocate(String path,
              String oldRoot,
              String newRoot)

Relocate a path from an base directory into a target directory

relocateToConfig

public String relocateToConfig(String path)

Relocate a path under the root directory to the configuration directory

relocateToRoot

public String relocateToRoot(String path)

Relocate a path under the configuration directory to the root directory

get

public Configuration get(String id)
                  throws IOException

Retrieves the Configuration object corresponding to the given file.

Throws:

IOException

parseConfigFile

public void parseConfigFile(String configFile)
                     throws IOException

Throws:

IOException

findNode

private DefaultMutableTreeNode findNode(String id,
                              boolean create,
                              String configFile)

Gets the tree node associated with the given file.