KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > storage > search > FieldValueBetweenConstraint


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 /**
13  * A constraint that restricts the value of a stepfield to be in a specified
14  * range of values (numerical or string).
15  * <p>
16  * This corresponds to the use of "between ... and ..." in SQL SELECT-syntax.
17  *
18  * @author Rob van Maris
19  * @version $Id: FieldValueBetweenConstraint.java,v 1.6 2004/12/23 17:31:05 pierre Exp $
20  * @since MMBase-1.7
21  */

22 public interface FieldValueBetweenConstraint extends FieldConstraint {
23
24     /**
25      * Gets the value of the lower limit of the range specified for this
26      * constraint.
27      */

28     Object JavaDoc getLowerLimit();
29
30     /**
31      * Gets the value of the upper limit of the range specified for this
32      * constraint.
33      */

34     Object JavaDoc getUpperLimit();
35
36     /**
37      * Returns a string representation of this FieldValueBetweenConstraint.
38      * The string representation has the form
39      * "FieldValueBetweenConstraint(inverse:&lt:inverse&gt;, field:&lt;field&gt;,
40      * casesensitive:&lt;casesensitive&gt;,
41      * lower:&lt;lowerLimit&gt;, upper:&lt;upperLimit&gt;)"
42      * where
43      * <ul>
44      * <li><em>&lt;inverse&gt;</em>is the value returned by
45      * {@link #isInverse isInverse()}
46      * <li><em>&lt;field&gt;</em> is the field alias returned by
47      * <code>FieldConstraint#getField().getAlias()</code>
48      * <li><em>&lt;casesensitive&gt;</em> is the value returned by
49      * {@link FieldConstraint#isCaseSensitive isCaseSensitive()}
50      * <li><em>&lt;lowerLimit&gt;</em> is the values returned by
51      * {@link #getLowerLimit getValues()}
52      * <li><em>&lt;upperLimit&gt;</em> is the values returned by
53      * {@link #getUpperLimit getValues()}
54      * </ul>
55      *
56      * @return A string representation of this FieldValueInConstraint.
57      */

58     public String JavaDoc toString();
59
60 }
61
Popular Tags