ConfigManager (IQM 3.5 API)

java.lang.Object
- at.mug.iqm.config.ConfigManager

```
public class ConfigManager
extends Object
```
This class is responsible for loading the configuration or writing the defaults.

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`configFileName`
`private String`	`configSchema`
`private static ConfigManager`	`currentConfigManager`
`static File`	`DEFAULT_IQM_CONF_DIR`
`static File`	`DEFAULT_IQM_ROOT_DIR`
`static File`	`DEFAULT_IQM_SCRIPT_DIR`
`static File`	`DEFAULT_IQM_TEMP_DIR`
`private InputStream`	`defaultConfigFileIS`
`private ArrayList<String>`	`errorMsgs`
`private IQMConfig`	`iqmConfiguration`
`private JAXBContext`	`jaxbContext`
`private static org.apache.log4j.Logger`	`logger`
`private Marshaller`	`marshaller`
`private Unmarshaller`	`unmarshaller`
`static String`	`USER_HOME`
`private File`	`xmlConfigFile`
`private File`	`xmlSchemaFile`
`private InputStream`	`xmlSchemaFileIS`

Constructor Summary

Constructors
Modifier Constructor and Description

private ConfigManager()
Create a new instance of the configuration manager.

Constructors
Modifier	Constructor and Description
`private`	`ConfigManager()` Create a new instance of the configuration manager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private String`	`extractSingleVariable(String s, ArrayList<String> envVarList)` Extract all keys from referenced environment variables from a given String `s`.
`File`	`getConfPath()` Get the currently configured configuration file path as file object.
`static ConfigManager`	`getCurrentInstance()`
`private IQMConfig`	`getDefaultIQMConfig()` Constructs a default configuration with the standard values for starting up the application.
`File`	`getDefaultIqmConfPath()`
`File`	`getDefaultIqmRootPath()`
`File`	`getDefaultIqmScriptPath()`
`File`	`getDefaultIqmTempPath()`
`String`	`getDefaultUserHome()`
`File`	`getImagePath()` Get the currently configured image path as file object.
`IQMConfig`	`getIQMConfig()` Gets the applications configuration, it constructs a default one, if it is null.
`boolean`	`getKeepExistingROIs()` Get a flag, whether or not the existing ROIs should be kept while drawing new ones.
`File`	`getRootPath()` Get the currently configured root file path as file object.
`File`	`getScriptPath()` Get the currently configured path to the script directory.
`File`	`getTempPath()` Get the currently configured temporary file path.
`File`	`getXmlSchemaFile()`
`private void`	`loadDefaultConfiguration()`
`private void`	`loadXMLConfiguration(File xmlFile)` Loads a configuration from an existing XML file.
`private void`	`loadXMLConfiguration(InputStream is)` Loads a configuration from an existing XML file.
`private String`	`parseEnvVars(String original)` This method gets the names of the environment variables from a specified String `s`.
`private String`	`resolve(String original, ArrayList<String> envVars)` Resolves the path from a list of environment variables.
`void`	`setConfPath(File path)` Updates the current configuration file with the specified `path` for the IQM configuration.
`void`	`setConfPath(String path)` Updates the current configuration file with the specified `path` for the IQM configuration.
`void`	`setImagePath(File path)` Updates the current configuration file with the specified `path` for the images.
`void`	`setImagePath(String path)` Updates the current configuration file with the specified `path` for the images.
`void`	`setKeepExistingROIs(boolean value)` Set the flag, whether or not the existing ROIs should be kept while drawing new ones.
`private void`	`setLastUpdate()` Each time the configuration is updated, write the time stamp too.
`void`	`setRootPath(File path)` Updates the current configuration file with the specified `path` for the IQM root.
`void`	`setRootPath(String path)` Updates the current configuration file with the specified `path` for the IQM root.
`void`	`setScriptPath(File path)` Updates the current configuration file with the specified `path` for the IQM configuration.
`void`	`setScriptPath(String path)` Updates the current configuration file with the specified `path` for the IQM configuration.
`void`	`setTempPath(File path)` Updates the current configuration file with the specified `path` for temporary files.
`void`	`setTempPath(String path)` Updates the current configuration file with the specified `path` for temporary files.
`void`	`setXmlSchemaFile(File xmlSchemaFile)`
`private void`	`validate()` Validates the configuration file against the defined schema.
`void`	`validateAndSetConfiguration()` Collects configuration violations and stores it in a `List<String>` of error messages.
`void`	`write()` Store the current configuration to the config file.
`private void`	`writeDefaultXMLConfiguration()` Writes a new default XML configuration file to the specified path in the file system.
`private void`	`writeXMLConfiguration()` Writes an XML configuration file to the specified path in the file system.

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.apache.log4j.Logger logger
```
  - currentConfigManager
```
private static ConfigManager currentConfigManager
```
  - USER_HOME
```
public static final String USER_HOME
```
  - DEFAULT_IQM_ROOT_DIR
```
public static final File DEFAULT_IQM_ROOT_DIR
```
  - DEFAULT_IQM_TEMP_DIR
```
public static final File DEFAULT_IQM_TEMP_DIR
```
  - DEFAULT_IQM_CONF_DIR
```
public static final File DEFAULT_IQM_CONF_DIR
```
  - DEFAULT_IQM_SCRIPT_DIR
```
public static final File DEFAULT_IQM_SCRIPT_DIR
```
  - configFileName
```
private final String configFileName
```
    See Also:
    
    Constant Field Values
  - configSchema
```
private final String configSchema
```
    See Also:
    
    Constant Field Values
  - defaultConfigFileIS
```
private InputStream defaultConfigFileIS
```
  - xmlConfigFile
```
private File xmlConfigFile
```
  - xmlSchemaFile
```
private File xmlSchemaFile
```
  - xmlSchemaFileIS
```
private InputStream xmlSchemaFileIS
```
  - jaxbContext
```
private JAXBContext jaxbContext
```
  - marshaller
```
private Marshaller marshaller
```
  - unmarshaller
```
private Unmarshaller unmarshaller
```
  - iqmConfiguration
```
private IQMConfig iqmConfiguration
```
  - errorMsgs
```
private ArrayList<String> errorMsgs
```
- Constructor Detail
  - ConfigManager
```
private ConfigManager()
               throws JAXBException
```
    Create a new instance of the configuration manager.
    
    Throws:
    
    JAXBException
- Method Detail
  - loadDefaultConfiguration
```
private void loadDefaultConfiguration()
                               throws JAXBException
```
    Throws:
    
    JAXBException
  - validateAndSetConfiguration
```
public void validateAndSetConfiguration()
                                 throws Exception
```
    Collects configuration violations and stores it in a List<String> of error messages. If there are some errors, throw new Exception and print error messages to log file.
    
    Throws:
    
    Exception - - if the configuration is invalid
  - loadXMLConfiguration
```
private void loadXMLConfiguration(File xmlFile)
                           throws JAXBException,
                                  Exception
```
    Loads a configuration from an existing XML file. The file is validated against the corresponding XML schema before loading.
    
    Throws:
    
    JAXBException - - if the XML file does not comply with the schema
    
    Exception
  - loadXMLConfiguration
```
private void loadXMLConfiguration(InputStream is)
                           throws JAXBException
```
    Loads a configuration from an existing XML file. The file is validated against the corresponding XML schema before loading.
    
    Throws:
    
    JAXBException - - if the XML file does not comply with the schema
  - validate
```
private void validate()
```
    Validates the configuration file against the defined schema.
  - writeDefaultXMLConfiguration
```
private void writeDefaultXMLConfiguration()
```
    Writes a new default XML configuration file to the specified path in the file system.
  - write
```
public void write()
```
    Store the current configuration to the config file.
  - writeXMLConfiguration
```
private void writeXMLConfiguration()
```
    Writes an XML configuration file to the specified path in the file system.
  - getXmlSchemaFile
```
public File getXmlSchemaFile()
```
    Returns:
    
    the xmlSchemaFile
  - setXmlSchemaFile
```
public void setXmlSchemaFile(File xmlSchemaFile)
```
    Parameters:
    
    xmlSchemaFile - the xmlSchemaFile to set
  - getIQMConfig
```
public IQMConfig getIQMConfig()
```
    Gets the applications configuration, it constructs a default one, if it is null.
    
    Returns:
    
    an IQMConfig object
  - getDefaultIQMConfig
```
private IQMConfig getDefaultIQMConfig()
```
    Constructs a default configuration with the standard values for starting up the application.
    
    Returns:
    
    an IQMConfig object
  - parseEnvVars
```
private String parseEnvVars(String original)
                     throws EnvVariableNotFoundException
```
    This method gets the names of the environment variables from a specified String s.
    
    Parameters:
    
    original - - the string from the configuration file
    
    Returns:
    
    a resolved pathname as String without environment variable references
    
    Throws:
    
    EnvVariableNotFoundException - if a specified environment variable cannot be found
  - extractSingleVariable
```
private String extractSingleVariable(String s,
                                     ArrayList<String> envVarList)
```
    Extract all keys from referenced environment variables from a given String s. This method works recursively
    
    Parameters:
    
    s - - the String to
    
    envVarList -
    
    Returns:
    
    a string
  - resolve
```
private String resolve(String original,
                       ArrayList<String> envVars)
                throws EnvVariableNotFoundException
```
    Resolves the path from a list of environment variables.
    
    Parameters:
    
    original - - the original string
    
    envVars - - the list of variable keys
    
    Returns:
    
    a reassembled, fully qualified path name
    
    Throws:
    
    EnvVariableNotFoundException - - if one of the keys is not available
  - getScriptPath
```
public File getScriptPath()
```
    Get the currently configured path to the script directory.
    
    Returns:
    
    scriptPath
  - getTempPath
```
public File getTempPath()
```
    Get the currently configured temporary file path.
    
    Returns:
    
    tempPath
  - getImagePath
```
public File getImagePath()
```
    Get the currently configured image path as file object.
    
    Returns:
    
    imagePath
  - getRootPath
```
public File getRootPath()
```
    Get the currently configured root file path as file object.
    
    Returns:
    
    rootPath
  - getConfPath
```
public File getConfPath()
```
    Get the currently configured configuration file path as file object.
    
    Returns:
    
    confPath
  - setTempPath
```
public void setTempPath(String path)
```
    Updates the current configuration file with the specified path for temporary files.
    
    Parameters:
    
    path - - temporary file store
  - setTempPath
```
public void setTempPath(File path)
```
    Updates the current configuration file with the specified path for temporary files.
    
    Parameters:
    
    path - - temporary file store
  - setImagePath
```
public void setImagePath(String path)
```
    Updates the current configuration file with the specified path for the images.
    
    Parameters:
    
    path - - last used image path
  - setImagePath
```
public void setImagePath(File path)
```
    Updates the current configuration file with the specified path for the images.
    
    Parameters:
    
    path - - last used image path
  - setRootPath
```
public void setRootPath(String path)
```
    Updates the current configuration file with the specified path for the IQM root.
    
    Parameters:
    
    path - - path to the root where the application has writing permissions
  - setRootPath
```
public void setRootPath(File path)
```
    Updates the current configuration file with the specified path for the IQM root.
    
    Parameters:
    
    path - - path to the root where the application has writing permissions
  - setConfPath
```
public void setConfPath(String path)
```
    Updates the current configuration file with the specified path for the IQM configuration.
    
    Parameters:
    
    path - - path to the configuration files where the application has writing permissions
  - setConfPath
```
public void setConfPath(File path)
```
    Updates the current configuration file with the specified path for the IQM configuration.
    
    Parameters:
    
    path - - path to the configuration files where the application has writing permissions
  - setScriptPath
```
public void setScriptPath(String path)
```
    Updates the current configuration file with the specified path for the IQM configuration.
    
    Parameters:
    
    path - - path to the Groovy script files where the application has writing permissions
  - setScriptPath
```
public void setScriptPath(File path)
```
    Updates the current configuration file with the specified path for the IQM configuration.
    
    Parameters:
    
    path - - path to the Groovy script files where the application has writing permissions
  - getKeepExistingROIs
```
public boolean getKeepExistingROIs()
```
    Get a flag, whether or not the existing ROIs should be kept while drawing new ones.
    If the config file does not contain any annotation tags, the default values will be written to the file.
    
    Returns:
    
    true or false
  - setKeepExistingROIs
```
public void setKeepExistingROIs(boolean value)
```
    Set the flag, whether or not the existing ROIs should be kept while drawing new ones.
    
    Parameters:
    
    value -
  - setLastUpdate
```
private void setLastUpdate()
```
    Each time the configuration is updated, write the time stamp too.
  - getCurrentInstance
```
public static ConfigManager getCurrentInstance()
```
  - getDefaultIqmConfPath
```
public File getDefaultIqmConfPath()
```
  - getDefaultIqmScriptPath
```
public File getDefaultIqmScriptPath()
```
  - getDefaultIqmRootPath
```
public File getDefaultIqmRootPath()
```
  - getDefaultIqmTempPath
```
public File getDefaultIqmTempPath()
```
  - getDefaultUserHome
```
public String getDefaultUserHome()
```

Class ConfigManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

currentConfigManager

USER_HOME

DEFAULT_IQM_ROOT_DIR

DEFAULT_IQM_TEMP_DIR

DEFAULT_IQM_CONF_DIR

DEFAULT_IQM_SCRIPT_DIR

configFileName

configSchema

defaultConfigFileIS

xmlConfigFile

xmlSchemaFile

xmlSchemaFileIS

jaxbContext

marshaller

unmarshaller

iqmConfiguration

errorMsgs

Constructor Detail

ConfigManager

Method Detail

loadDefaultConfiguration

validateAndSetConfiguration

loadXMLConfiguration

loadXMLConfiguration

validate

writeDefaultXMLConfiguration

write

writeXMLConfiguration

getXmlSchemaFile

setXmlSchemaFile

getIQMConfig

getDefaultIQMConfig

parseEnvVars

extractSingleVariable

resolve

getScriptPath

getTempPath

getImagePath

getRootPath

getConfPath

setTempPath

setTempPath

setImagePath

setImagePath

setRootPath

setRootPath

setConfPath

setConfPath

setScriptPath

setScriptPath

getKeepExistingROIs

setKeepExistingROIs

setLastUpdate

getCurrentInstance

getDefaultIqmConfPath

getDefaultIqmScriptPath

getDefaultIqmRootPath

getDefaultIqmTempPath

getDefaultUserHome