dragon.config

Interface ConfigureNode

All Known Implementing Classes:

BasicConfigureNode

public interface ConfigureNode

Interface of Congituration Node

A configuration node can be the root node of the configuaration XML file or the XML node for an object. An object node should have at least two attributes, type and id, which are used to search the object. Usually, the type is the interface the object implements. The id is an integer value greater than zero. An object node contains mutilple parameters which can be a simple datatype or an object.

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

Modifier and Type	Method and Description
boolean	exist(String key)
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean def)
double	getDouble(String key)
double	getDouble(String key, double def)
ConfigureNode	getFirstChild() Gets the first object node within the current configuration node
int	getInt(String key)
int	getInt(String key, int def)
ConfigureNode	getNextSibling() Gets the next object node in parallel to the current onfiguration node
Class	getNodeClass()
int	getNodeID()
String	getNodeName()
String	getNodeType()
String	getParameterType(String key) If the parameter corresponds to an object, it returns the type (usually the interface) of the object.
ConfigureNode	getParentNode() Gets the parent node of the current object node
String	getString(String key)
String	getString(String key, String def) If the given parameter exists, return its values, otherwise return the default value.

Method Detail

getParentNode

ConfigureNode getParentNode()

Gets the parent node of the current object node

Returns:

the parent node of the current object node

getFirstChild

ConfigureNode getFirstChild()

Gets the first object node within the current configuration node

Returns:

the first object node within the current configuration node

getNextSibling

ConfigureNode getNextSibling()

Gets the next object node in parallel to the current onfiguration node

Returns:

the next object node in parallel to the current onfiguration node

getNodeName

String getNodeName()

Returns:

the name of the object node

getNodeID

int getNodeID()

Returns:

the id of the object node

getNodeType

String getNodeType()

Returns:

the type of the object node

getNodeClass

Class getNodeClass()

Returns:

the class name the object corresponds to

getString

String getString(String key)

getString

String getString(String key,
                 String def)

If the given parameter exists, return its values, otherwise return the default value.

Parameters:

key - the name of the parameter

def - the default value of the parameter

Returns:

the string of the parameter

getInt

int getInt(String key)

getInt

int getInt(String key,
           int def)

getBoolean

boolean getBoolean(String key)

getBoolean

boolean getBoolean(String key,
                   boolean def)

getDouble

double getDouble(String key)

getDouble

double getDouble(String key,
                 double def)

getParameterType

String getParameterType(String key)

If the parameter corresponds to an object, it returns the type (usually the interface) of the object. Otherwise, it returns null.

Parameters:

key - the name of the parameter

Returns:

the type of the object

exist

boolean exist(String key)

Parameters:

key - the name of the parameter

Returns:

true if the parameter exists