de.mhus.lib.core.config

Class DirectoryToConfigWrapper

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.DirectoryToConfigWrapper

All Implemented Interfaces:

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

public class DirectoryToConfigWrapper
extends IConfig

DirectoryToConfigWrapper class.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Field Summary

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
DirectoryToConfigWrapper(WritableResourceNode node) Constructor for DirectoryToConfigWrapper.

Method Summary

Modifier and Type	Method and Description
WritableResourceNode	createConfig(String key) Create a new config and append it at the end of the list.
boolean	equals(Object obj)
boolean	getBoolean(String name, boolean def) getBoolean.
Calendar	getCalendar(String name) getCalendar.
Date	getDate(String name) getDate.
double	getDouble(String name, double def) getDouble.
String	getExtracted(String key) Returns a compiled and executed string.
String	getExtracted(String key, String def) getExtracted.
float	getFloat(String name, float def) getFloat.
InputStream	getInputStream(String key) Return the input stream of a content resource.
int	getInt(String name, int def) getInt.
long	getLong(String name, long def) getLong.
String	getName() Return a name of this config element could also be null.
ResourceNode	getNode(String key) Returns a inner configuration by the name.
String[]	getNodeKeys() Return all possible, existing inner configuration names.
ResourceNode[]	getNodes() Return all inner configurations ignoring the name.
ResourceNode[]	getNodes(String key) Return all inner configurations by the given name.
Number	getNumber(String name, Number def) getNumber.
ResourceNode	getParent() return the parent config if possible.
Object	getProperty(String name) Overwrite this function to provide values in string format.
int	getProperty(String name, int def) getProperty.
String[]	getPropertyKeys() Return all existing keys.
String	getString(String name, String def) getString.
URL	getUrl() getUrl.
int	hashCode()
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.
Iterator<Map.Entry<String,Object>>	iterator()
Set<String>	keys() keys.
int	moveConfig(ResourceNode config, int newPos) Move the position of the configuration in the hole set of configurations.
void	removeConfig(ResourceNode config) Remove a config element from the set.
void	removeProperty(String key) Remove the property field in the list of properties.
void	setBoolean(String name, boolean value) setBoolean.
void	setCalendar(String name, Calendar value) setCalendar.
void	setDate(String name, Date value) setDate.
void	setDouble(String name, double value) setDouble.
void	setFloat(String name, float value) setFloat.
void	setInt(String name, int value) setInt.
void	setLong(String name, long value) setLong.
void	setNumber(String name, Number value) setNumber.
void	setProperty(String key, Object value) Overwrite this function to allow changes in properties.
void	setString(String name, String value) setString.
String	toString()

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

hasContent, isValide

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

getExtracted, getInputStream, getNodeByPath

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

getBoolean, getString, toMap

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

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

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

log

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DirectoryToConfigWrapper

public DirectoryToConfigWrapper(WritableResourceNode node)

Constructor for DirectoryToConfigWrapper.

Parameters:

node - a WritableResourceNode object.

Method Detail

getProperty

public Object getProperty(String name)

Overwrite this function to provide values in string format.

Specified by:

getProperty in class IProperties

Parameters:

name - a String object.

Returns:

null if the property not exists or the property value.

createConfig

public WritableResourceNode createConfig(String key)
                                  throws MException

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:

key - a String object.

Returns:

a WritableResourceNode object.

Throws:

MException - if editing is not possible

getProperty

public int getProperty(String name,
                       int def)
                throws MException

getProperty.

Overrides:

getProperty in class IProperties

Parameters:

name - a String object.

def - a int.

Returns:

a int.

Throws:

MException - if any.

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

getString

public String getString(String name,
                        String def)

getString.

Overrides:

getString in class IProperties

Parameters:

name - a String object.

def - a String object.

Returns:

a String object.

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.

getNode

public ResourceNode 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.

getBoolean

public boolean getBoolean(String name,
                          boolean def)

getBoolean.

Overrides:

getBoolean in class IProperties

Parameters:

name - a String object.

def - a boolean.

Returns:

a boolean.

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

getNodes

public ResourceNode[] 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.

getInt

public int getInt(String name,
                  int def)

getInt.

Overrides:

getInt in class IProperties

Parameters:

name - a String object.

def - a int.

Returns:

a int.

getNodes

public ResourceNode[] 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.

setString

public void setString(String name,
                      String value)

setString.

Overrides:

setString in class WritableResourceNode

Parameters:

name - a String object.

value - a String object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLong

public long getLong(String name,
                    long def)

getLong.

Overrides:

getLong in class IProperties

Parameters:

name - a String object.

def - a long.

Returns:

a long.

getNodeKeys

public String[] getNodeKeys()

Return all possible, existing inner configuration names.

Specified by:

getNodeKeys in class ResourceNode

Returns:

an array of String objects.

getName

public String getName()
               throws MException

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.

Throws:

MException - if any.

toString

public String toString()

Overrides:

toString in class MObject

getFloat

public float getFloat(String name,
                      float def)

getFloat.

Overrides:

getFloat in class IProperties

Parameters:

name - a String object.

def - a float.

Returns:

a float.

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.

getExtracted

public String getExtracted(String key)
                    throws MException

Returns a compiled and executed string. The string is compiled with StringCompiler and is cached. Example is "this is the value of another $anothername,default$" or with the prefix "root.": "This is a root attribute $root.name$ User the "../" prefix to go one back ...

Overrides:

getExtracted in class ResourceNode

Parameters:

key - a String object.

Returns:

a String object.

Throws:

MException - if any.

See Also:

StringCompiler

getDouble

public double getDouble(String name,
                        double def)

getDouble.

Overrides:

getDouble in class IProperties

Parameters:

name - a String object.

def - a double.

Returns:

a double.

getCalendar

public Calendar getCalendar(String name)
                     throws MException

getCalendar.

Overrides:

getCalendar in class IProperties

Parameters:

name - a String object.

Returns:

a Calendar object.

Throws:

MException - if any.

getExtracted

public String getExtracted(String key,
                           String def)
                    throws MException

getExtracted.

Overrides:

getExtracted in class ResourceNode

Parameters:

key - a String object.

def - a String object.

Returns:

a String object.

Throws:

MException - if any.

getDate

public Date getDate(String name)

getDate.

Overrides:

getDate in class IProperties

Parameters:

name - a String object.

Returns:

a Date object.

getParent

public ResourceNode getParent()

return the parent config if possible.

Specified by:

getParent in class ResourceNode

Returns:

a ResourceNode object.

keys

public Set<String> keys()

keys.

Overrides:

keys in class ResourceNode

Returns:

a Set object.

setInt

public void setInt(String name,
                   int value)

setInt.

Overrides:

setInt in class IProperties

Parameters:

name - a String object.

value - a int.

setLong

public void setLong(String name,
                    long value)

setLong.

Overrides:

setLong in class IProperties

Parameters:

name - a String object.

value - a long.

setDouble

public void setDouble(String name,
                      double value)

setDouble.

Overrides:

setDouble in class IProperties

Parameters:

name - a String object.

value - a double.

setFloat

public void setFloat(String name,
                     float value)

setFloat.

Overrides:

setFloat in class IProperties

Parameters:

name - a String object.

value - a float.

setBoolean

public void setBoolean(String name,
                       boolean value)

setBoolean.

Overrides:

setBoolean in class IProperties

Parameters:

name - a String object.

value - a boolean.

setCalendar

public void setCalendar(String name,
                        Calendar value)

setCalendar.

Overrides:

setCalendar in class IProperties

Parameters:

name - a String object.

value - a Calendar object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setDate

public void setDate(String name,
                    Date value)

setDate.

Overrides:

setDate in class IProperties

Parameters:

name - a String object.

value - a Date object.

setNumber

public void setNumber(String name,
                      Number value)

setNumber.

Overrides:

setNumber in class IProperties

Parameters:

name - a String object.

value - a Number object.

getNumber

public Number getNumber(String name,
                        Number def)

getNumber.

Overrides:

getNumber in class IProperties

Parameters:

name - a String object.

def - a Number object.

Returns:

a Number object.

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.

removeProperty

public void removeProperty(String key)

Remove the property field in the list of properties.

Specified by:

removeProperty in class IProperties

Parameters:

key - a String object.

setProperty

public void setProperty(String key,
                        Object value)

Overwrite this function to allow changes in properties.

Specified by:

setProperty in class IProperties

Parameters:

key - a String object.

value - a Object object.

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.

iterator

public Iterator<Map.Entry<String,Object>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,Object>>

Overrides:

iterator in class IProperties

getUrl

public URL getUrl()

getUrl.

Specified by:

getUrl in class ResourceNode

Returns:

a URL object.