KickJava   Java API By Example, From Geeks To Geeks.

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


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 compares the value of two stepfields.
14  *
15  * @author Rob van Maris
16  * @version $Id: CompareFieldsConstraint.java,v 1.2 2003/03/10 11:50:43 pierre Exp $
17  * @since MMBase-1.7
18  */

19 public interface CompareFieldsConstraint extends FieldCompareConstraint {
20     /**
21      * Gets the second associated field.
22      */

23     StepField getField2();
24
25     /**
26      * Returns a string representation of this CompareFieldsConstraint.
27      * The string representation has the form
28      * "CompareFieldsConstraint(inverse:&lt:inverse>, field:<field>,
29      * casesensitive:<casesensitive>, operator:<operator>,
30      * field2:<field2>)"
31      * where
32      * <ul>
33      * <li><em>&lt;inverse&gt;</em>is the value returned by
34      * {@link #isInverse isInverse()}
35      * <li><em>&lt;field&gt;</em> is the field alias returned by
36      * <code>FieldConstraint#getField().getAlias()</code>
37      * <li><em>&lt;casesensitive&gt;</em> is the value returned by
38      * {@link FieldConstraint#isCaseSensitive isCaseSensitive()}
39      * <li><em>&lt;operator&gt;</em> is the value returned by
40      * {@link FieldCompareConstraint#getOperator getOperator()}
41      * <li><em>&lt;field2&gt;</em> is the field alias returned by
42      * <code>#getField2().getAlias()</code>
43      * </ul>
44      *
45      * @return A string representation of this CompareFieldsConstraint.
46      */

47     public String JavaDoc toString();
48
49     /** @link dependency
50      * @supplierRole field2*/

51     /*#StepField lnkStepField1;*/
52 }
53
Popular Tags