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 lower-case representation of the supplied operand, used in a {@link Comparison}
31 * constraint.
32 */
33 @Immutable
34 public class LowerCase implements DynamicOperand {
35 private static final long serialVersionUID = 1L;
36
37 private final DynamicOperand operand;
38
39 /**
40 * Create a dynamic operand that evaluates to the lower-case representation of the supplied operand.
41 *
42 * @param operand the operand that is to be lower-cased
43 */
44 public LowerCase( DynamicOperand 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 operand() {
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 selectorName() {
63 return operand.selectorNames().iterator().next();
64 }
65
66 /**
67 * {@inheritDoc}
68 *
69 * @see org.modeshape.graph.query.model.DynamicOperand#selectorNames()
70 */
71 public Set<SelectorName> selectorNames() {
72 return operand.selectorNames();
73 }
74
75 /**
76 * {@inheritDoc}
77 *
78 * @see java.lang.Object#toString()
79 */
80 @Override
81 public String toString() {
82 return Visitors.readable(this);
83 }
84
85 /**
86 * {@inheritDoc}
87 *
88 * @see java.lang.Object#hashCode()
89 */
90 @Override
91 public int hashCode() {
92 return operand.hashCode();
93 }
94
95 /**
96 * {@inheritDoc}
97 *
98 * @see java.lang.Object#equals(java.lang.Object)
99 */
100 @Override
101 public boolean equals( Object obj ) {
102 if (obj == this) return true;
103 if (obj instanceof LowerCase) {
104 LowerCase that = (LowerCase)obj;
105 return this.operand.equals(that.operand);
106 }
107 return false;
108 }
109
110 /**
111 * {@inheritDoc}
112 *
113 * @see org.modeshape.graph.query.model.Visitable#accept(org.modeshape.graph.query.model.Visitor)
114 */
115 public void accept( Visitor visitor ) {
116 visitor.visit(this);
117 }
118 }