001    /**
002     * Copyright (c) 2010, SIB. All rights reserved.
003     * 
004     * SIB (Swiss Institute of Bioinformatics) - http://www.isb-sib.ch Host -
005     * https://sourceforge.net/projects/javaprotlib/
006     * 
007     * Redistribution and use in source and binary forms, with or without
008     * modification, are permitted provided that the following conditions are met:
009     * Redistributions of source code must retain the above copyright notice, this
010     * list of conditions and the following disclaimer. Redistributions in binary
011     * form must reproduce the above copyright notice, this list of conditions and
012     * the following disclaimer in the documentation and/or other materials provided
013     * with the distribution. Neither the name of the SIB/GENEBIO nor the names of
014     * its contributors may be used to endorse or promote products derived from this
015     * software without specific prior written permission.
016     * 
017     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
020     * ARE DISCLAIMED. IN NO EVENT SHALL SIB/GENEBIO BE LIABLE FOR ANY DIRECT,
021     * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022     * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
024     * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026     * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027     */
028    package org.expasy.jpl.commons.collection.tree;
029    
030    
031    import java.util.List;
032    import java.util.Set;
033    
034    
035    /**
036     * A {@code TreeView} interface should be implemented by any tree like
037     * structured read-only node.
038     * 
039     * @author nikitin
040     * 
041     * @param <T> the node type.
042     * 
043     * @version 1.0
044     * 
045     */
046    public interface TreeView<T> {
047            
048            /** @return the parent node. */
049            TreeView<T> getParent();
050            
051            /** @return the direct children of the node. */
052            List<? extends TreeView<T>> getChildren();
053            
054            /** @return the tree leaves. */
055            Set<? extends TreeView<T>> getLeaves();
056            
057            /** @return the tree nodes. */
058            Set<? extends TreeView<T>> getNodes();
059            
060            /** @return the number of children of this node. */
061            int getNumberOfChildren();
062            
063            /** @return true if root node. */
064            boolean isRoot();
065            
066            /** @return the parent node. */
067            boolean isLeave();
068            
069            /** @return the child node at index. */
070            TreeView<T> getChildAt(int index);
071            
072            /** @return the node data. */
073            T getData();
074            
075    }