001/*
002 * Copyright (c) 2004-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
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.kepler.gui;
031
032import java.util.Vector;
033
034import javax.swing.tree.TreePath;
035
036/**
037 * A class to contain the search results from the library. Conceivably, this
038 * class could hold any result of a tree search.
039 * 
040 *@author berkley
041 *@since February 17, 2005
042 */
043public class LibrarySearchResults extends Vector {
044        /**
045         * constructor
046         */
047        public LibrarySearchResults() {
048                super();
049        }
050
051        /**
052         * adds a TreePath to the results
053         * 
054         *@param path
055         *            the TreePath to add to the results
056         */
057        public void add(TreePath path) {
058                // System.out.println("path: " + path.toString());
059                super.addElement(path);
060        }
061
062        /**
063         * returns the result at the specified index
064         * 
065         *@param index
066         *            the index of the result to return
067         *@return The treePath value
068         */
069        public TreePath getTreePath(int index) {
070                return (TreePath) super.elementAt(index);
071        }
072
073        /**
074         * return a formatted string representation of this object
075         * 
076         *@return Description of the Return Value
077         */
078        public String toString() {
079                StringBuffer sb = new StringBuffer();
080                sb.append("{\n");
081                for (int i = 0; i < this.size(); i++) {
082                        // We need to call toString() on TreePath so as to
083                        // avoid "The method append(Object) is ambiguous"
084                        // under Eclipse 3.2 with Java 1.5
085                        sb.append(this.getTreePath(i).toString()).append("\n");
086                }
087                sb.append("\n}");
088                return sb.toString();
089        }
090}