org.pentaho.reporting.tools.configeditor.model

Class ConfigTreeModuleNode

java.lang.Object

org.pentaho.reporting.tools.configeditor.model.AbstractConfigTreeNode

org.pentaho.reporting.tools.configeditor.model.ConfigTreeModuleNode

All Implemented Interfaces:

TreeNode, ConfigTreeNode

public class ConfigTreeModuleNode
extends AbstractConfigTreeNode

The config tree module node is used to represent a module in the report configuration. Modules collect all task-specific configuration keys and represent a report module from the package manager.

It is assumed, that all modules define their keys within the namespace of their package.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
ConfigTreeModuleNode(org.pentaho.reporting.libraries.base.boot.Module module) Creates a new module node for the given module object and report configuration.

Method Summary

Modifier and Type	Method and Description
void	addAssignedKey(ConfigDescriptionEntry key) Adds the given key to the list of assigned keys, if not already added.
boolean	getAllowsChildren() Returns true if the receiver allows children.
ConfigDescriptionEntry[]	getAssignedKeys() Returns the list of assigned keys as object array.
String	getConfigurationPrefix() Returns the configuration prefix of this module.
org.pentaho.reporting.libraries.base.boot.Module	getModule() Returns the module represented by this node.
boolean	isLeaf() Returns true if the receiver is a leaf.
void	removeAssignedKey(ConfigDescriptionEntry key) Removed the given key description from the list of assigned keys.
String	toString() Returns a string representation of this object.

Methods inherited from class org.pentaho.reporting.tools.configeditor.model.AbstractConfigTreeNode

add, children, getChildAt, getChildCount, getIndex, getName, getParent, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigTreeModuleNode

public ConfigTreeModuleNode(org.pentaho.reporting.libraries.base.boot.Module module)

Creates a new module node for the given module object and report configuration.

Parameters:

module - the module for which to build a tree node.

Method Detail

getModule

public org.pentaho.reporting.libraries.base.boot.Module getModule()

Returns the module represented by this node.

Returns:

the module used in this node.

getConfigurationPrefix

public String getConfigurationPrefix()

Returns the configuration prefix of this module.

Returns:

the configuration prefix.

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

the string representing this object.

See Also:

Object.toString()

isLeaf

public boolean isLeaf()

Returns true if the receiver is a leaf.

Specified by:

isLeaf in interface TreeNode

Overrides:

isLeaf in class AbstractConfigTreeNode

Returns:

true if the receiver is a leaf.

getAllowsChildren

public boolean getAllowsChildren()

Returns true if the receiver allows children.

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractConfigTreeNode

Returns:

true if the receiver allows children.

addAssignedKey

public void addAssignedKey(ConfigDescriptionEntry key)

Adds the given key to the list of assigned keys, if not already added.

Parameters:

key - the new key to be added

Throws:

NullPointerException - if the given key is null.

removeAssignedKey

public void removeAssignedKey(ConfigDescriptionEntry key)

Removed the given key description from the list of assigned keys.

Parameters:

key - the key that should be removed.

Throws:

NullPointerException - if the given key is null.

getAssignedKeys

public ConfigDescriptionEntry[] getAssignedKeys()

Returns the list of assigned keys as object array.

Returns:

the assigned keys as array.