de.mhus.lib.core.config

Class XmlConfig

java.lang.Object

de.mhus.lib.core.MLog

de.mhus.lib.core.lang.MObject

de.mhus.lib.core.IProperties

de.mhus.lib.core.directory.ResourceNode

de.mhus.lib.core.directory.WritableResourceNode

de.mhus.lib.core.config.IConfig

de.mhus.lib.core.config.XmlConfig

All Implemented Interfaces:

ILog, Serializable, Iterable<Map.Entry<String,Object>>

Direct Known Subclasses:

XmlConfigFile

public class XmlConfig
extends IConfig

Implements a configuration loaded from xml structures.

Version:

$Id: $Id

Author:

mhu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changed
protected Element	element
protected String	name
protected XmlConfig	parent

Fields inherited from class de.mhus.lib.core.directory.WritableResourceNode

MOVE_DOWN, MOVE_FIRST, MOVE_LAST, MOVE_UP

Fields inherited from class de.mhus.lib.core.directory.ResourceNode

compiledCache, compiler

Constructor Summary

Constructors

Constructor and Description
XmlConfig() Constructor for XmlConfig.
XmlConfig(Element elementByPath) Constructor for XmlConfig.
XmlConfig(XmlConfig parent, Element elementByPath) Constructor for XmlConfig.

Method Summary

Modifier and Type	Method and Description
XmlConfig	createConfig(String name) Create a new config and append it at the end of the list.
boolean	equals(Object obj)
Document	getDocument() getDocument.
InputStream	getInputStream(String key) Return the input stream of a content resource.
String	getName() Return a name of this config element could also be null.
WritableResourceNode	getNode(String key) Returns a inner configuration by the name.
String[]	getNodeKeys() Return all possible, existing inner configuration names.
WritableResourceNode[]	getNodes() Return all inner configurations ignoring the name.
WritableResourceNode[]	getNodes(String key) Return all inner configurations by the given name.
WritableResourceNode	getParent() return the parent config if possible.
String	getProperty(String key) Overwrite this function to provide values in string format.
String[]	getPropertyKeys() Return all existing keys.
URL	getUrl() getUrl.
Element	getXmlElement() getXmlElement.
boolean	isConfigChanged() isConfigChanged.
boolean	isEditable() Overwrite this function and return true if the property set can be edited.
boolean	isProperty(String name) Return true if the property exists.
int	moveConfig(ResourceNode config, int newPos) Move the position of the configuration in the hole set of configurations.
void	readConfig(Reader file) readConfig.
void	removeConfig(ResourceNode config) Remove a config element from the set.
void	removeProperty(String name) Remove the property field in the list of properties.
void	setProperty(String key, Object val) Overwrite this function to allow changes in properties.
void	writeConfig(Writer configStream) writeConfig.
void	writeConfig(Writer configStream, boolean intend) writeConfig.

Methods inherited from class de.mhus.lib.core.config.IConfig

hasContent, isValide

Methods inherited from class de.mhus.lib.core.directory.WritableResourceNode

setString

Methods inherited from class de.mhus.lib.core.directory.ResourceNode

getExtracted, getExtracted, getExtracted, getInputStream, getNodeByPath, keys

Methods inherited from class de.mhus.lib.core.IProperties

getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getInt, getLong, getNumber, getProperty, getString, getString, iterator, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, toMap

Methods inherited from class de.mhus.lib.core.lang.MObject

base, base, createBase, forkBase, installBase, isBase, leaveBase, toString

Methods inherited from class de.mhus.lib.core.MLog

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

element

protected Element element

changed

protected boolean changed

parent

protected XmlConfig parent

name

protected String name

Constructor Detail

XmlConfig

public XmlConfig()

Constructor for XmlConfig.

XmlConfig

public XmlConfig(Element elementByPath)

Constructor for XmlConfig.

Parameters:

elementByPath - a Element object.

XmlConfig

public XmlConfig(XmlConfig parent,
                 Element elementByPath)

Constructor for XmlConfig.

Parameters:

parent - a XmlConfig object.

elementByPath - a Element object.

Method Detail

getDocument

public Document getDocument()

getDocument.

Returns:

a Document object.

readConfig

public void readConfig(Reader file)
                throws Exception

readConfig.

Parameters:

file - a Reader object.

Throws:

Exception - if any.

getNode

public WritableResourceNode getNode(String key)

Returns a inner configuration by the name. Inner configurations are not unique. If more then one configurations exists it will return the first one. if no configuration exists it returns null.

Specified by:

getNode in class ResourceNode

Parameters:

key - a String object.

Returns:

a ResourceNode object.

getNodes

public WritableResourceNode[] getNodes()

Return all inner configurations ignoring the name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Returns:

an array of ResourceNode objects.

getNodes

public WritableResourceNode[] getNodes(String key)

Return all inner configurations by the given name. The order is like in the configuration file. This never returns null.

Specified by:

getNodes in class ResourceNode

Parameters:

key - a String object.

Returns:

an array of ResourceNode objects.

getNodeKeys

public String[] getNodeKeys()

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode

Returns:

an array of String objects.

getPropertyKeys

public String[] getPropertyKeys()

Return all existing keys. A property key is unique.

Specified by:

getPropertyKeys in class ResourceNode

Returns:

an array of String objects.

removeProperty

public void removeProperty(String name)

Remove the property field in the list of properties.

Specified by:

removeProperty in class IProperties

Parameters:

name - a String object.

setProperty

public void setProperty(String key,
                        Object val)

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class IProperties

Parameters:

key - a String object.

val - a Object object.

writeConfig

public void writeConfig(Writer configStream)
                 throws Exception

writeConfig.

Parameters:

configStream - a Writer object.

Throws:

Exception - if any.

writeConfig

public void writeConfig(Writer configStream,
                        boolean intend)
                 throws Exception

writeConfig.

Parameters:

configStream - a Writer object.

intend - a boolean.

Throws:

Exception - if any.

createConfig

public XmlConfig createConfig(String name)

Create a new config and append it at the end of the list. After creation the element is already at the end of the list.

Specified by:

createConfig in class WritableResourceNode

Parameters:

name - a String object.

Returns:

a WritableResourceNode object.

getProperty

public String getProperty(String key)

Overwrite this function to provide values in string format.

Specified by:

getProperty in class IProperties

Parameters:

key - a String object.

Returns:

null if the property not exists or the property value.

isProperty

public boolean isProperty(String name)

Return true if the property exists.

Specified by:

isProperty in class IProperties

Parameters:

name - a String object.

Returns:

a boolean.

isConfigChanged

public boolean isConfigChanged()

isConfigChanged.

Returns:

a boolean.

getName

public String getName()

Return a name of this config element could also be null. The name most time is the name of a sub config.

Specified by:

getName in class ResourceNode

Returns:

a String object.

moveConfig

public int moveConfig(ResourceNode config,
                      int newPos)
               throws MException

Move the position of the configuration in the hole set of configurations. If the config is not part of the set it will throw an exception. The first position is 0.

Specified by:

moveConfig in class WritableResourceNode

Parameters:

config - The config object which you want to move

newPos - Absolute new position or one of the move operators MOVE_UP, MOVE_DOWN, MOVE_FIRST, MOVE_LAST

Returns:

The new pos of the config

Throws:

MException - if editing is not possible or the position is out of range

removeConfig

public void removeConfig(ResourceNode config)
                  throws MException

Remove a config element from the set. If the config element is not part of the set it will not throw an error.

Specified by:

removeConfig in class WritableResourceNode

Parameters:

config - The config object which should be removed.

Throws:

MException - if editing is not possible

isEditable

public boolean isEditable()

Overwrite this function and return true if the property set can be edited.

Specified by:

isEditable in class IProperties

Returns:

a boolean.

getParent

public WritableResourceNode getParent()

return the parent config if possible.

Specified by:

getParent in class ResourceNode

Returns:

a ResourceNode object.

getXmlElement

public Element getXmlElement()

getXmlElement.

Returns:

a Element object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInputStream

public InputStream getInputStream(String key)

Return the input stream of a content resource.

Specified by:

getInputStream in class ResourceNode

Parameters:

key - Name of a rendition or null for the default content

Returns:

a InputStream object.

getUrl

public URL getUrl()

getUrl.

Specified by:

getUrl in class ResourceNode

Returns:

a URL object.