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 net.jcip.annotations.Immutable;
27  
28  /**
29   * A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a {@link Comparison}
30   * constraint.
31   */
32  @Immutable
33  public class LowerCase extends DynamicOperand {
34      private static final long serialVersionUID = 1L;
35  
36      private final DynamicOperand operand;
37  
38      /**
39       * Create a dynamic operand that evaluates to the lower-case representation of the supplied operand.
40       * 
41       * @param operand the operand that is to be lower-cased
42       */
43      public LowerCase( DynamicOperand operand ) {
44          super(operand);
45          this.operand = operand;
46      }
47  
48      /**
49       * Get the dynamic operand that is to be lower-cased.
50       * 
51       * @return the dynamic operand; never null
52       */
53      public final DynamicOperand getOperand() {
54          return operand;
55      }
56  
57      /**
58       * Get the selector symbol upon which this operand applies.
59       * 
60       * @return the one selector names used by this operand; never null
61       */
62      public SelectorName getSelectorName() {
63          return getSelectorNames().iterator().next();
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 operand.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 LowerCase) {
95              LowerCase that = (LowerCase)obj;
96              return this.operand.equals(that.operand);
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 }