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 length of the supplied propety values, used in a {@link Comparison} constraint.
30 */
31 @Immutable
32 public class Length extends DynamicOperand {
33 private static final long serialVersionUID = 1L;
34
35 private final PropertyValue propertyValue;
36
37 /**
38 * Create a dynamic operand that evaluates to the length of the supplied property values.
39 *
40 * @param propertyValue the property value operand
41 */
42 public Length( PropertyValue propertyValue ) {
43 super(propertyValue);
44 this.propertyValue = propertyValue;
45 }
46
47 /**
48 * Get the property value whose length is being constrained.
49 *
50 * @return the property value being constrained; never null
51 */
52 public final PropertyValue getPropertyValue() {
53 return propertyValue;
54 }
55
56 /**
57 * Get the selector symbol upon which this operand applies.
58 *
59 * @return the one selector names used by this operand; never null
60 */
61 public SelectorName getSelectorName() {
62 return getSelectorNames().iterator().next();
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 getPropertyValue().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 Length) {
94 Length that = (Length)obj;
95 return this.propertyValue.equals(that.propertyValue);
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 }