ConfigurationManager (cismet Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.tools.configuration.ConfigurationManager

```
public class ConfigurationManager
extends Object
```
Configuaration Manager.

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de

Field Summary

Fields
Modifier and Type Field and Description

static String DUMMY_NS_ATTR_VALUE

static String SUBSTITUTION_ATTR

Fields
Modifier and Type	Field and Description
`static String`	`DUMMY_NS_ATTR_VALUE`
`static String`	`SUBSTITUTION_ATTR`

Constructor Summary

Constructors
Constructor and Description

ConfigurationManager()
Creates a new instance of ConfigurationManager.

Constructors
Constructor and Description
`ConfigurationManager()` Creates a new instance of ConfigurationManager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConfigurable(Configurable configurable)` Appends specified `Configurable` to the list `configurables`.
`void`	`configure()` Configures all `Configurable` in `configuables`; Uses the deafault Path to the local root Object.
`void`	`configure(Configurable singleConfig)` Configures the specified `Configurable`; Uses the default Path to the local root Object.
`void`	`configure(Configurable singleConfig, String path)` Configures the specified `Configurable`; Uses a specified path to the local Object.
`void`	`configure(Configurable singleConfig, String path, boolean merge)` Configures the specified `Configurable`; Uses a specified path to the local Object.
`void`	`configure(String path)` Configures all `Configurable` in `configuables`; Uses a specified Path to the local root Object.
`void`	`configure(String path, boolean merge)` Configures all `Configurable` in `configurables`; Uses a specified Path to the local root Object.
`void`	`configureFromClasspath()` Configures all `Configurable` in `configurables`; Uses the Classpath to the local root Object.
`void`	`configureFromClasspath(Configurable singleConfig)` Configures the specified `Configurable`; Uses the Classpath to the local root Object.
`void`	`configureFromClasspath(String url, Configurable singleConfig)` Configures the specified `Configurable`; Uses the Classpath to the local root Object.
`Set<org.jdom.Element>`	`createElements(String xmlSnippet)` Creates a `Set` from the given xml snippet.
`String`	`getClassPathFolder()` Getter for `classPathFolder`.
`org.jdom.Document`	`getConfigurationDocument()` Writes a Configuration File in specified path.
`String`	`getDefaultFileName()` Getter for `defaultFileName`.
`String`	`getFallBackFileName()` Getter for `fallBackFileName`.
`String`	`getFileName()` Getter for `fileName`.
`String`	`getFileSeperator()` Getter for `fs`.
`String`	`getFolder()` Getter for `folder`.
`String`	`getHome()` Getter for `home`.
`String`	`getLocalAbsoluteConfigurationFolder()` Returns the Url "~/.cismet/"
`String`	`getSubstitutionAttr(org.jdom.Element e)` Returns the value of the substitution attribute of the given `Element`.
`boolean`	`hasSubstitutionAttr(org.jdom.Element e)` Checks whether the given `Element` has a substitution attribute.
`void`	`initialiseLocalConfigurationClasspath()` Initialises the Local Configuration Classpath.
`boolean`	`isEqual(org.jdom.Document doc1, org.jdom.Document doc2)` Writes a Configuration File in specified path.
`void`	`removeConfigurable(Configurable configurable)` Removes specified `Configurable` from the list `configurables`.
`void`	`removeVoid(org.jdom.Element child)` Removes an `Element` from its parent if the `Element` does not have any children or any attributes except the substitution attribute.
`void`	`resolveNamespace(org.jdom.Element parent, Set<org.jdom.Element> newChildren)` Iterates through all the given children and tries to resolve every children's DUMMY`Namespace` against the given parent.
`void`	`setClassPathFolder(String classPathFolder)` Setter for `classPathFolder`.
`void`	`setDefaultFileName(String defaultFileName)` Setter for `defaultFileName`.
`void`	`setFallBackFileName(String fallBackFileName)` Setter for `fallBackFileName`.
`void`	`setFileName(String fileName)` Setter for `fileName`.
`void`	`setFileSeperator(String fs)` Setter for `fs`.
`void`	`setFolder(String folder)` Setter for `folder`.
`void`	`setHome(String home)` Setter for `home`.
`void`	`writeConfiguration()` Writes a new Configuration File into the LocalAbsouluteConfigurationFolder.
`void`	`writeConfiguration(String path)` Writes a Configuration File in specified path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUBSTITUTION_ATTR
```
public static final String SUBSTITUTION_ATTR
```
    See Also:
    
    Constant Field Values
  - DUMMY_NS_ATTR_VALUE
```
public static final String DUMMY_NS_ATTR_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConfigurationManager
```
public ConfigurationManager()
```
    Creates a new instance of ConfigurationManager.
- Method Detail
  - addConfigurable
```
public void addConfigurable(Configurable configurable)
```
    Appends specified Configurable to the list configurables.
    
    Parameters:
    
    configurable - Configurable, which should get append to the List
  - removeConfigurable
```
public void removeConfigurable(Configurable configurable)
```
    Removes specified Configurable from the list configurables.
    
    Parameters:
    
    configurable - Configurable, which should get removed from the List
  - getFileName
```
public String getFileName()
```
    Getter for fileName.
    
    Returns:
    
    fileName
  - setFileName
```
public void setFileName(String fileName)
```
    Setter for fileName.
    
    Parameters:
    
    fileName - fileName
  - getFolder
```
public String getFolder()
```
    Getter for folder.
    
    Returns:
    
    folder
  - setFolder
```
public void setFolder(String folder)
```
    Setter for folder.
    
    Parameters:
    
    folder - folder
  - configure
```
public void configure()
```
    Configures all Configurable in configuables; Uses the deafault Path to the local root Object.
    
    See Also:
    
    configure(de.cismet.tools.configuration.Configurable)
  - configure
```
public void configure(String path)
```
    Configures all Configurable in configuables; Uses a specified Path to the local root Object. This is a convenient method for configure(String, false)
    
    Parameters:
    
    path - specified path
    
    See Also:
    
    configure(de.cismet.tools.configuration.Configurable, java.lang.String), configure(java.lang.String, boolean)
  - configure
```
public void configure(Configurable singleConfig)
```
    Configures the specified Configurable; Uses the default Path to the local root Object.
    
    Parameters:
    
    singleConfig - specified Configurable; if ==null: uses all Configurable in configurables.
    
    See Also:
    
    configure(de.cismet.tools.configuration.Configurable, java.lang.String)
  - configure
```
public void configure(Configurable singleConfig,
                      String path)
```
    Configures the specified Configurable; Uses a specified path to the local Object.
    
    Parameters:
    
    singleConfig - specified Configurable; if ==null: uses all Configurable in configurables.
    
    path - specified path to the local root Object.
    
    See Also:
    
    #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
  - configure
```
public void configure(Configurable singleConfig,
                      String path,
                      boolean merge)
```
    Configures the specified Configurable; Uses a specified path to the local Object.
    
    Parameters:
    
    singleConfig - specified Configurable; if ==null: uses all Configurable in configurables.
    
    path - specified path to the local root Object.
    
    merge - iff true, the given configuration will be merged with the current configuration
    
    See Also:
    
    #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
  - configureFromClasspath
```
public void configureFromClasspath()
```
    Configures all Configurable in configurables; Uses the Classpath to the local root Object.
    
    See Also:
    
    configureFromClasspath(de.cismet.tools.configuration.Configurable)
  - configureFromClasspath
```
public void configureFromClasspath(Configurable singleConfig)
```
    Configures the specified Configurable; Uses the Classpath to the local root Object.
    
    Parameters:
    
    singleConfig - specified Configurable; if ==null uses all Configurable in configurables.
    
    See Also:
    
    #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
  - configureFromClasspath
```
public void configureFromClasspath(String url,
                                   Configurable singleConfig)
                            throws Exception
```
    Configures the specified Configurable; Uses the Classpath to the local root Object.
    
    Parameters:
    
    url - path
    
    singleConfig - singleConfig specified Configurable; if ==null uses all Configurable in configurables.
    
    Throws:
    
    Exception - Throws Excpetion if anything went wrong.
    
    See Also:
    
    #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
  - configure
```
public void configure(String path,
                      boolean merge)
```
    Configures all Configurable in configurables; Uses a specified Path to the local root Object.
    
    Parameters:
    
    path - specified path
    
    merge - iff true, the given configuration will be merged with the current configuration
    
    See Also:
    
    configure(de.cismet.tools.configuration.Configurable, java.lang.String)
  - initialiseLocalConfigurationClasspath
```
public void initialiseLocalConfigurationClasspath()
```
    Initialises the Local Configuration Classpath.
  - resolveNamespace
```
public void resolveNamespace(org.jdom.Element parent,
                             Set<org.jdom.Element> newChildren)
```
    Iterates through all the given children and tries to resolve every children's DUMMYNamespace against the given parent. The implementation traverses upwards beginning with the given parent Element and uses the value of the first occurrence of the child's DUMMYNamespace prefix as a new Namespace for the child.
    
    Parameters:
    
    parent - the Element used for resolving the Namespaces
    
    newChildren - the candidate Elements probably being resolved
    
    See Also:
    
    DUMMY_NS_ATTR_VALUE
  - hasSubstitutionAttr
```
public boolean hasSubstitutionAttr(org.jdom.Element e)
```
    Checks whether the given Element has a substitution attribute.
    
    Parameters:
    
    e - the Element to be checked for a substitution attribute
    
    Returns:
    
    true if the Element has a substitution attribute, false otherwise
    
    See Also:
    
    SUBSTITUTION_ATTR
  - getSubstitutionAttr
```
public String getSubstitutionAttr(org.jdom.Element e)
```
    Returns the value of the substitution attribute of the given Element.
    
    Parameters:
    
    e - the Element containing the substitution attribute
    
    Returns:
    
    the value of the substitution attribute of the given Element
    
    See Also:
    
    SUBSTITUTION_ATTR
  - createElements
```
public Set<org.jdom.Element> createElements(String xmlSnippet)
```
    Creates a Set from the given xml snippet. This implementation assumes that there is a single root Element whose only purpose is to wrap the Elements to be created. In other words this implementation will return the child Elements of the Document's root Element. The returned Elements are detached from their root so they can be inserted into another Document.
    
    Parameters:
    
    xmlSnippet - the xml String the consisting of a single root Element and the desired child Elements
    
    Returns:
    
    the detached children of the root Element of the given xml snippet
  - removeVoid
```
public void removeVoid(org.jdom.Element child)
```
    Removes an Element from its parent if the Element does not have any children or any attributes except the substitution attribute.
    
    Parameters:
    
    child - the child that is a candidate for removal
  - writeConfiguration
```
public void writeConfiguration()
```
    Writes a new Configuration File into the LocalAbsouluteConfigurationFolder.
    
    See Also:
    
    getLocalAbsoluteConfigurationFolder(), writeConfiguration(java.lang.String)
  - getLocalAbsoluteConfigurationFolder
```
public String getLocalAbsoluteConfigurationFolder()
```
    Returns the Url "~/.cismet/"
    
    Returns:
    
    ~/.cismet/
  - isEqual
```
public boolean isEqual(org.jdom.Document doc1,
                       org.jdom.Document doc2)
```
    Writes a Configuration File in specified path.
    
    Parameters:
    
    doc1 - path path
    
    doc2 - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - writeConfiguration
```
public void writeConfiguration(String path)
```
    Writes a Configuration File in specified path.
    
    Parameters:
    
    path - path
  - getConfigurationDocument
```
public org.jdom.Document getConfigurationDocument()
```
    Writes a Configuration File in specified path.
    
    Returns:
    
    DOCUMENT ME!
  - getDefaultFileName
```
public String getDefaultFileName()
```
    Getter for defaultFileName.
    
    Returns:
    
    defaultFileName
  - setDefaultFileName
```
public void setDefaultFileName(String defaultFileName)
```
    Setter for defaultFileName.
    
    Parameters:
    
    defaultFileName - defaultFileName
  - getClassPathFolder
```
public String getClassPathFolder()
```
    Getter for classPathFolder.
    
    Returns:
    
    classPathFolder
  - setClassPathFolder
```
public void setClassPathFolder(String classPathFolder)
```
    Setter for classPathFolder.
    
    Parameters:
    
    classPathFolder - classPathFolder
  - getHome
```
public String getHome()
```
    Getter for home.
    
    Returns:
    
    home
  - setHome
```
public void setHome(String home)
```
    Setter for home.
    
    Parameters:
    
    home - home
  - getFileSeperator
```
public String getFileSeperator()
```
    Getter for fs.
    
    Returns:
    
    file separator
  - setFileSeperator
```
public void setFileSeperator(String fs)
```
    Setter for fs.
    
    Parameters:
    
    fs - file seperator
  - getFallBackFileName
```
public String getFallBackFileName()
```
    Getter for fallBackFileName.
    
    Returns:
    
    fallBackFileName
  - setFallBackFileName
```
public void setFallBackFileName(String fallBackFileName)
```
    Setter for fallBackFileName.
    
    Parameters:
    
    fallBackFileName - fallBackFileName

Class ConfigurationManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUBSTITUTION_ATTR

DUMMY_NS_ATTR_VALUE

Constructor Detail

ConfigurationManager

Method Detail

addConfigurable

removeConfigurable

getFileName

setFileName

getFolder

setFolder

configure

configure

configure

configure

configure

configureFromClasspath

configureFromClasspath

configureFromClasspath

configure

initialiseLocalConfigurationClasspath

resolveNamespace

hasSubstitutionAttr

getSubstitutionAttr

createElements

removeVoid

writeConfiguration

getLocalAbsoluteConfigurationFolder

isEqual

writeConfiguration

getConfigurationDocument

getDefaultFileName

setDefaultFileName

getClassPathFolder

setClassPathFolder

getHome

setHome

getFileSeperator

setFileSeperator

getFallBackFileName

setFallBackFileName