View Javadoc

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