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 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed 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.query.model;
25
26 import net.jcip.annotations.Immutable;
27
28 /**
29 * A dynamic operand that evaluates to the path of a node given by a selector, used in a {@link Comparison} constraint.
30 */
31 @Immutable
32 public class NodePath extends DynamicOperand {
33 private static final long serialVersionUID = 1L;
34
35 /**
36 * Create a dynamic operand that evaluates to the path of the node identified by the selector.
37 *
38 * @param selectorName the name of the selector
39 * @throws IllegalArgumentException if the selector name or property name are null
40 */
41 public NodePath( SelectorName selectorName ) {
42 super(selectorName);
43 }
44
45 /**
46 * Get the selector symbol upon which this operand applies.
47 *
48 * @return the one selector names used by this operand; never null
49 */
50 public SelectorName getSelectorName() {
51 return getSelectorNames().iterator().next();
52 }
53
54 /**
55 * {@inheritDoc}
56 *
57 * @see java.lang.Object#toString()
58 */
59 @Override
60 public String toString() {
61 return Visitors.readable(this);
62 }
63
64 /**
65 * {@inheritDoc}
66 *
67 * @see java.lang.Object#hashCode()
68 */
69 @Override
70 public int hashCode() {
71 return getSelectorNames().hashCode();
72 }
73
74 /**
75 * {@inheritDoc}
76 *
77 * @see java.lang.Object#equals(java.lang.Object)
78 */
79 @Override
80 public boolean equals( Object obj ) {
81 if (obj == this) return true;
82 if (obj instanceof NodePath) {
83 NodePath that = (NodePath)obj;
84 return this.getSelectorNames().equals(that.getSelectorNames());
85 }
86 return false;
87 }
88
89 /**
90 * {@inheritDoc}
91 *
92 * @see org.modeshape.graph.query.model.Visitable#accept(org.modeshape.graph.query.model.Visitor)
93 */
94 public void accept( Visitor visitor ) {
95 visitor.visit(this);
96 }
97 }