edu.udo.cs.yale.tools
Class GroupTree

java.lang.Object
  edu.udo.cs.yale.tools.GroupTree

public class GroupTree
extends java.lang.Object

A group tree manages operator descriptions in a tree like manner. This is useful to present the operators in groups and subgroups and eases operator selection in the GUI.

Version:

$Id: GroupTree.java,v 2.16 2006/08/03 14:39:31 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private java.util.Map<java.lang.String,GroupTree>	children The subgroups of this group.
private java.lang.String	name The name of this group.
private java.util.Set<OperatorDescription>	operators The list of operator in this group.
private GroupTree	parent The parent of this group.

Constructor Summary

GroupTree(java.lang.String name)
Creates a new group tree with no operators and children.

Method Summary

private void	addAllOperatorDescriptions(java.util.Set<OperatorDescription> operators)
void	addOperatorDescription(OperatorDescription description) Adds an operator to this group.
void	addSubGroup(GroupTree child) Adds a subgroup to this group.
java.util.Set<OperatorDescription>	getAllOperatorDescriptions() Returns all operator in this group and recursively the operators of all children.
java.lang.String	getName() Returns the name of this group.
java.util.Set<OperatorDescription>	getOperatorDescriptions() Returns all operator descriptions in this group or an empty list if this group does not contain any operators.
GroupTree	getParent() Returns the parent of this group.
GroupTree	getSubGroup(java.lang.String name) Returns the subgroup with the given name.
java.util.Collection<GroupTree>	getSubGroups() Returns a set of all children group trees.
void	setParent(GroupTree parent) Sets the parent of this group.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

operators

private java.util.Set<OperatorDescription> operators

The list of operator in this group.

children

private java.util.Map<java.lang.String,GroupTree> children

The subgroups of this group.

name

private java.lang.String name

The name of this group.

parent

private GroupTree parent

The parent of this group.

Constructor Detail

GroupTree

public GroupTree(java.lang.String name)

Creates a new group tree with no operators and children.

Method Detail

getName

public java.lang.String getName()

Returns the name of this group.

setParent

public void setParent(GroupTree parent)

Sets the parent of this group.

getParent

public GroupTree getParent()

Returns the parent of this group. Returns null if no parent does exist.

addSubGroup

public void addSubGroup(GroupTree child)

Adds a subgroup to this group.

getSubGroup

public GroupTree getSubGroup(java.lang.String name)

Returns the subgroup with the given name.

getSubGroups

public java.util.Collection<GroupTree> getSubGroups()

Returns a set of all children group trees.

addOperatorDescription

public void addOperatorDescription(OperatorDescription description)

Adds an operator to this group.

getOperatorDescriptions

public java.util.Set<OperatorDescription> getOperatorDescriptions()

Returns all operator descriptions in this group or an empty list if this group does not contain any operators.

getAllOperatorDescriptions

public java.util.Set<OperatorDescription> getAllOperatorDescriptions()

Returns all operator in this group and recursively the operators of all children.

addAllOperatorDescriptions

private void addAllOperatorDescriptions(java.util.Set<OperatorDescription> operators)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object