de.mhus.lib.core.directory

Class ResourceNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

EmptyResourceNode, FileResource, WritableResourceNode

public abstract class ResourceNode
extends IProperties

This interface represent a generic Directory Node. Nodes are sets of definitions. The definitions can be bound together to a inner Nodes.

Version:

$Id: $Id

Author:

mikehummel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,CompiledString>	compiledCache
protected de.mhus.lib.core.directory.ResourceNode.ConfigStringCompiler	compiler

Constructor Summary

Constructors

Constructor and Description
ResourceNode()

Method Summary

Modifier and Type	Method and Description
String	getExtracted(String key) Returns a compiled and executed string.
String	getExtracted(String key, String def) getExtracted.
protected String	getExtracted(String key, String def, int level) getExtracted.
InputStream	getInputStream() Return the default content input stream.
abstract InputStream	getInputStream(String key) Return the input stream of a content resource.
abstract String	getName() Return a name of this config element could also be null.
abstract ResourceNode	getNode(String key) Returns a inner configuration by the name.
ResourceNode	getNodeByPath(String path) getNodeByPath.
abstract String[]	getNodeKeys() Return all possible, existing inner configuration names.
abstract ResourceNode[]	getNodes() Return all inner configurations ignoring the name.
abstract ResourceNode[]	getNodes(String key) Return all inner configurations by the given name.
abstract ResourceNode	getParent() return the parent config if possible.
abstract String[]	getPropertyKeys() Return all existing keys.
abstract URL	getUrl() getUrl.
abstract boolean	hasContent() hasContent.
abstract boolean	isValide() isValide.
Set<String>	keys() keys.

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

getBoolean, getBoolean, getCalendar, getDate, getDouble, getFloat, getInt, getLong, getNumber, getProperty, getProperty, getString, getString, isEditable, isProperty, iterator, removeProperty, setBoolean, setCalendar, setDate, setDouble, setFloat, setInt, setLong, setNumber, setProperty, setString, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

compiler

protected de.mhus.lib.core.directory.ResourceNode.ConfigStringCompiler compiler

compiledCache

protected HashMap<String,CompiledString> compiledCache

Constructor Detail

ResourceNode

public ResourceNode()

Method Detail

getPropertyKeys

public abstract String[] getPropertyKeys()

Return all existing keys. A property key is unique.

Returns:

an array of String objects.

getNode

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

Parameters:

key - a String object.

Returns:

a ResourceNode object.

getNodes

public abstract ResourceNode[] getNodes()

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

Returns:

an array of ResourceNode objects.

getNodes

public abstract ResourceNode[] getNodes(String key)

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

Parameters:

key - a String object.

Returns:

an array of ResourceNode objects.

getNodeKeys

public abstract String[] getNodeKeys()

Return all possible, existing inner configuration names.

Returns:

an array of String objects.

getName

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

Returns:

a String object.

Throws:

MException - if any.

getInputStream

public InputStream getInputStream()

Return the default content input stream.

Returns:

a InputStream object.

getInputStream

public abstract InputStream getInputStream(String key)

Return the input stream of a content resource.

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

Parameters:

key - a String object.

Returns:

a String object.

Throws:

MException - if any.

See Also:

StringCompiler

getExtracted

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

getExtracted.

Parameters:

key - a String object.

def - a String object.

Returns:

a String object.

Throws:

MException - if any.

getParent

public abstract ResourceNode getParent()

return the parent config if possible.

Returns:

a ResourceNode object.

keys

public Set<String> keys()

keys.

Specified by:

keys in class IProperties

Returns:

a Set object.

getExtracted

protected String getExtracted(String key,
                              String def,
                              int level)
                       throws MException

getExtracted.

Parameters:

key - a String object.

def - a String object.

level - a int.

Returns:

a String object.

Throws:

MException - if any.

getUrl

public abstract URL getUrl()

getUrl.

Returns:

a URL object.

isValide

public abstract boolean isValide()

isValide.

Returns:

a boolean.

hasContent

public abstract boolean hasContent()

hasContent.

Returns:

a boolean.

getNodeByPath

public ResourceNode getNodeByPath(String path)

getNodeByPath.

Parameters:

path - a String object.

Returns:

a ResourceNode object.

Since:

3.2.9