1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * Unless otherwise indicated, all code in ModeShape is licensed
10 * to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph;
25
26 import org.modeshape.graph.property.Name;
27 import org.modeshape.graph.property.Path;
28
29 /**
30 * An extended {@link Node} that includes the ability to get nodes in the {@link Subgraph subgraph} relative to this node.
31 */
32 public interface SubgraphNode extends Node {
33 /**
34 * Get the node at the supplied path that is relative to this node.
35 *
36 * @param childName the name of the child node
37 * @return the node, or null if the node is not {@link Subgraph#includes(Path) included} in these results
38 */
39 SubgraphNode getNode( Name childName );
40
41 /**
42 * Get the node at the supplied path that is relative to this node.
43 *
44 * @param relativePath the name that makes up a relative path to the node that is an immediate child of the
45 * {@link Subgraph#getRoot() root}
46 * @return the node, or null if the node is not {@link Subgraph#includes(Path) included} in these results
47 */
48 SubgraphNode getNode( Path relativePath );
49 }