grouptree.java

著名的开源仿真软件yale

/*
 *  YALE - Yet Another Learning Environment
 *  Copyright (C) 2002, 2003
 *      Simon Fischer, Ralf Klinkenberg, Ingo Mierswa, 
 *          Katharina Morik, Oliver Ritthoff
 *      Artificial Intelligence Unit
 *      Computer Science Department
 *      University of Dortmund
 *      44221 Dortmund,  Germany
 *  email: [e-mail]
 *  web:   http://yale.cs.uni-dortmund.de/
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License as 
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version. 
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 */
package edu.udo.cs.yale.tools.param;

import java.util.Collection;
import java.util.Set;
import java.util.Iterator;
import java.util.Map;
import java.util.HashMap;
import java.util.TreeMap;
import java.util.TreeSet;

/** 
 *  @version $Id: GroupTree.java,v 2.1 2003/08/21 15:18:17 fischer Exp $
 */
public class GroupTree {

    /** The list of operator in this group. */
    private Set operators   = new TreeSet();
    /** The subgroups of this group. */
    private Map children     = new TreeMap(); 
    /** The name of this group. */
    private String name      = null;
    /** The parent of this group. */
    private GroupTree parent = null;


    /** Creates a new group tree with no operators and children. */
    public GroupTree(String name) {
	this.name = name;
    }


    /** Returns the name of this group. */
    public String getName() {
	return name;
    }

    /** Sets the parent of this group. */
    public void setParent(GroupTree parent) {
	this.parent = parent;
    }

    /** Returns the parent of this group. Returns null if no parent does exist. */
    public GroupTree getParent() {
	return parent;
    }

    /** Adds a subgroup to this group. */
    public void addSubGroup(GroupTree child) {
	children.put(child.getName(), child);
	child.setParent(this);
    }

    /** Returns the subgroup with the given name. */
    public GroupTree getSubGroup(String name) {
	return (GroupTree)children.get(name);
    }

    /** Returns a set of all children group tree. */
    public Collection getSubGroups() {
	return children.values();
    }

//      /** Returns main group. Returns null, if this group has no parent. */
//      public GroupTree getMainGroup() {
//  	if (parent == null) return null;
//  	if (parent.getParent() == null) return this;
//  	else return parent.getMainGroup();
//      }

    /** Adds an operator to this group. */
    public void addOperator(String operator) {
	operators.add(operator);
    }

    /** Returns all operators in this group or an empty list if this operator does not contain 
     *  any operators. */
    public Set getOperators() {
	return operators;
    }

    /** Returns all operator in this group and recursively the operators of all children. */
    public Set getAllOperators() {
	Set result = new TreeSet();
	addAllOperators(result);
	return result;
    }

    private void addAllOperators(Set operators) {
	operators.addAll(this.operators);
	Iterator i = children.values().iterator();
	while (i.hasNext()) {
	    GroupTree child = (GroupTree)i.next();
	    child.addAllOperators(operators);
	}
    }
}