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.jcr.api.query.qom;
25  
26  import javax.jcr.query.qom.Comparison;
27  import javax.jcr.query.qom.DynamicOperand;
28  import javax.jcr.query.qom.Ordering;
29  
30  /**
31   * A dynamic operand that represents a (binary) arithmetic operation upon one or more other operands, used in {@link Comparison}
32   * and {@link Ordering} components.
33   */
34  public interface ArithmeticOperand extends DynamicOperand {
35  
36      /**
37       * Get the operator for this binary operand.
38       * 
39       * @return the operator; never null
40       */
41      public String getOperator();
42  
43      /**
44       * Get the left-hand operand.
45       * 
46       * @return the left-hand operator; never null
47       */
48      public DynamicOperand getLeft();
49  
50      /**
51       * Get the right-hand operand.
52       * 
53       * @return the right-hand operator; never null
54       */
55      public DynamicOperand getRight();
56  }