001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors.
008     *
009     * Unless otherwise indicated, all code in JBoss DNA is licensed
010     * to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     * 
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph;
025    
026    import org.jboss.dna.graph.property.Name;
027    import org.jboss.dna.graph.property.Path;
028    
029    /**
030     * An extended {@link Node} that includes the ability to get nodes in the {@link Subgraph subgraph} relative to this node.
031     */
032    public interface SubgraphNode extends Node {
033        /**
034         * Get the node at the supplied path that is relative to this node.
035         * 
036         * @param childName the name of the child node
037         * @return the node, or null if the node is not {@link Subgraph#includes(Path) included} in these results
038         */
039        SubgraphNode getNode( Name childName );
040    
041        /**
042         * Get the node at the supplied path that is relative to this node.
043         * 
044         * @param relativePath the name that makes up a relative path to the node that is an immediate child of the
045         *        {@link Subgraph#getRoot() root}
046         * @return the node, or null if the node is not {@link Subgraph#includes(Path) included} in these results
047         */
048        SubgraphNode getNode( Path relativePath );
049    }