001/*
002 * Copyright (c) 2004-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: aschultz $'
006 * '$Date: 2011-04-15 03:58:02 +0000 (Fri, 15 Apr 2011) $' 
007 * '$Revision: 27518 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.ecoinformatics.seek.ecogrid.quicksearch;
031
032import ptolemy.kernel.CompositeEntity;
033import ptolemy.kernel.util.IllegalActionException;
034import ptolemy.kernel.util.NameDuplicationException;
035import ptolemy.kernel.util.Workspace;
036
037/**
038 * The root of a result tree. This is a marker class to identify the entity that
039 * makes up the root, so that it can be differentiated from other containers in
040 * which a ResultRecord might be placed.
041 * 
042 * @author Matt Jones
043 */
044public class ResultTreeRoot extends CompositeEntity {
045        /**
046         * Construct the root node, setting its name to "name".
047         * 
048         * @param name
049         *            the name of the root node.
050         * @throws IllegalActionException
051         *             when the action can not be completed
052         * @throws NameDuplicationException
053         *             when the name is already in use
054         */
055        public ResultTreeRoot(String name) throws IllegalActionException,
056                        NameDuplicationException {
057                this(name,new Workspace());
058        }
059        
060        public ResultTreeRoot(String name, Workspace workspace) throws IllegalActionException,
061                        NameDuplicationException {
062                super(workspace);
063                this.setName(name);
064        }
065}