com.sapportals.wcm.util.config

Class ConfigCollection

java.lang.Object
  com.sapportals.wcm.util.config.ConfigCollection

public class ConfigCollection
extends Object

A ConfigCollection is a hirarchical representation of a configuration file. Copyright (c) SAP AG 2001-2002

Constructor Summary

ConfigCollection(String name)
Create a new ConfigCollection.

Method Summary

void	addChild(ConfigCollection configCollection) Add a child ConfigCollection.
ConfigCollection	getByPath(String path) Get a ConfigCollection by its path in dot-notation.
ConfigCollection	getChild(String name) Get a child ConfigCollection by its name.
Collection	getChildren() Get all children of the ConfigCollection.
String	getName() Get the name of the ConfigCollection.
String	getProperty(String name) Get a property by its name.
Collection	getPropertyNames() Get all property names in this ConfigCollection.
void	putProperty(String name, String value) Set/add a property to the ConfigCollection.
void	removeChild(String name) Remove a child ConfigCollection.
void	removeProperty(String name) Remove a property from the ConfigCollection
void	setByPath(String path, ConfigCollection configCollection) Set/Replace a child ConfigCollection by its relative path in dot-notation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigCollection

public ConfigCollection(String name)

Create a new ConfigCollection.

Parameters:

name - the name of the ConfigCollection (the root-node has name = null )

Method Detail

getName

public String getName()

Get the name of the ConfigCollection. The root-node has name = null.

Returns:

The name of the ConfigCollection

addChild

public void addChild(ConfigCollection configCollection)

Add a child ConfigCollection.

Parameters:

configCollection - The child to be added

removeChild

public void removeChild(String name)

Remove a child ConfigCollection.

Parameters:

name - TBD: Description of the incoming method parameter

getChild

public ConfigCollection getChild(String name)

Get a child ConfigCollection by its name.

Parameters:

name - The name of the child

Returns:

The child ConfigCollection or null if none is found

getByPath

public ConfigCollection getByPath(String path)

Get a ConfigCollection by its path in dot-notation.

Parameters:

path - The path in dot-notation

Returns:

null if none is found

setByPath

public void setByPath(String path,
                      ConfigCollection configCollection)

Set/Replace a child ConfigCollection by its relative path in dot-notation.

Parameters:

path - The path in dot-notation

configCollection - The child ConfigCollection to be set

getChildren

public Collection getChildren()

Get all children of the ConfigCollection.

Returns:

A Collection of ConfigCollections

putProperty

public void putProperty(String name,
                        String value)

Set/add a property to the ConfigCollection.

Parameters:

name - The name of the property (dot-notation will be resolved)

value - The value of the property

removeProperty

public void removeProperty(String name)

Remove a property from the ConfigCollection

Parameters:

name - The name of the property to by removed (dot-notation will be resoved )

getPropertyNames

public Collection getPropertyNames()

Get all property names in this ConfigCollection.

Returns:

A Collection of property names

getProperty

public String getProperty(String name)

Get a property by its name.

Parameters:

name - The name of the property (dot-notation will by resolved)

Returns:

The value of the property or null if none is found

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM