Package jmri

Interface CatalogTree

  • All Superinterfaces:
    java.lang.Comparable<NamedBean>, NamedBean, PropertyChangeProvider, javax.swing.tree.TreeModel
    All Known Implementing Classes:
    AbstractCatalogTree, CatalogTreeFS, CatalogTreeIndex

    public interface CatalogTree
    extends NamedBean, javax.swing.tree.TreeModel
    Represents a CatalogTree, a tree displaying a taxonomy - e.g. a file system directory, or an index of references or a table of contents built according to the user's taxonomy.

    Specific implementations are in the jmri.jmrit.catalog package.

    The states and names are Java Bean parameters, so that listeners can be registered to be notified of any changes.

    Each CatalogTree object has a two names. The "user" name is entirely free form, and can be used for any purpose. The "system" name is provided by the purpose-specific implementations.

    This file is part of JMRI.

    JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

    JMRI 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.

    • Method Detail

      • insertNodes

        void insertNodes​(java.lang.String pName,
                         java.lang.String pPath,
                         CatalogTreeNode pParent)
        Recursively add a representation of the resources below a particular resource
        pName - Name of the resource to be scanned; this is only used for the human-readable tree
        pPath - Path to this resource, including the pName part
        pParent - Node for the parent of the resource to be scanned, e.g. where in the tree to insert it.
      • insertNodes

        void insertNodes​(java.lang.String pathToRoot)
        Starting point to recursively add nodes to the tree by scanning a file directory
        pathToRoot - Path to Directory to be scanned
      • getRoot

        CatalogTreeNode getRoot()
        Get the root element of the tree as a jmri.CatalogTreeNode object. (Instead of Object, as parent swing.TreeModel provides)
        Specified by:
        getRoot in interface javax.swing.tree.TreeModel