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