FieldValueInConstraint


1   /*
2   
3   This software is OSI Certified Open Source Software.
4   OSI Certified is a certification mark of the Open Source Initiative.
5   
6   The license (Mozilla version 1.0) can be read at the MMBase site.
7   See http://www.MMBase.org/license
8   
9   */
10  package org.mmbase.storage.search;
11  
12  import java.util.*;
13  
14  /**
15   * A constraint that restricts the value of a stepfield to be in a specified list of values.
16   * <p>
17   * This corresponds to the use of "in (...)" in SQL SELECT-syntax.
18   *
19   * @author Rob van Maris
20   * @version $Id: FieldValueInConstraint.java,v 1.6 2004/12/23 17:31:05 pierre Exp $
21   * @since MMBase-1.7
22   */
23  public interface FieldValueInConstraint extends FieldConstraint {
24      /**
25       * Gets the list of values that is specified for this constraint.
26       */
27      SortedSet getValues();
28  
29      /**
30       * Returns a string representation of this FieldValueInConstraint.
31       * The string representation has the form
32       * "FieldValueInConstraint(inverse:&lt:inverse&gt;, field:&lt;field&gt;,
33       *  casesensitive:&lt;casesensitive&gt;, values:&lt;values&gt;)"
34       * where
35       * <ul>
36       * <li><em>&lt;inverse&gt;</em>is the value returned by
37       *      {@link #isInverse isInverse()}
38       * <li><em>&lt;field&gt;</em> is the field alias returned by
39       *     <code>FieldConstraint#getField().getAlias()</code>
40       * <li><em>&lt;casesensitive&gt;</em> is the value returned by
41       *     {@link FieldConstraint#isCaseSensitive isCaseSensitive()}
42       * <li><em>&lt;values&gt;</em> is the values returned by
43       *     {@link #getValues getValues()}
44       * </ul>
45       *
46       * @return A string representation of this FieldValueInConstraint.
47       */
48      public String   toString();
49  
50  }
51
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags