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     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed 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 net.jcip.annotations.Immutable;
027    import org.jboss.dna.graph.property.Path;
028    
029    /**
030     * A set of nodes returned from a {@link Graph graph}, with methods to access the properties and children of the nodes in the
031     * result. The {@link #iterator()} method can be used to iterate all over the nodes in the result.
032     * 
033     * @author Randall Hauch
034     */
035    @Immutable
036    public interface Results extends Graph.BaseResults<Node> {
037    
038        /**
039         * Get the graph containing the node.
040         * 
041         * @return the graph
042         */
043        Graph getGraph();
044    
045        /**
046         * Get the node at the supplied location.
047         * 
048         * @param path the path of the node in these results
049         * @return the node, or null if the node is not {@link #includes(Path) included} in these results
050         */
051        Node getNode( String path );
052    
053        /**
054         * Get the node at the supplied location.
055         * 
056         * @param path the path of the node in these results
057         * @return the node, or null if the node is not {@link #includes(Path) included} in these results
058         */
059        Node getNode( Path path );
060    
061        /**
062         * Get the node at the supplied location.
063         * 
064         * @param location the location of the node
065         * @return the node, or null if the node is not {@link #includes(Path) included} in these results
066         */
067        Node getNode( Location location );
068    
069        /**
070         * Return whether these results include a node at the supplied location.
071         * 
072         * @param path the path of the node in these results
073         * @return true if this subgraph includes the supplied location, or false otherwise
074         */
075        boolean includes( String path );
076    
077        /**
078         * Return whether this subgraph has a node at the supplied location.
079         * 
080         * @param path the path of the node in these results
081         * @return true if these results includes the supplied location, or false otherwise
082         */
083        boolean includes( Path path );
084    
085        /**
086         * Return whether this subgraph has a node at the supplied location.
087         * 
088         * @param location the location of the node in these results
089         * @return true if these results includes the supplied location, or false otherwise
090         */
091        boolean includes( Location location );
092    
093    }