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  
29  /**
30   * A dynamic operand that evaluates to the value(s) of a single or any reference property on a selector, used in a
31   * {@link Comparison} constraint.
32   */
33  public interface ReferenceValue extends DynamicOperand {
34      /**
35       * Get the selector symbol upon which this operand applies.
36       * 
37       * @return the one selector names used by this operand; never null
38       */
39      public String getSelectorName();
40  
41      /**
42       * Get the name of the one reference property.
43       * 
44       * @return the property name; or null if this operand applies to any reference property
45       */
46      public String getPropertyName();
47  }