KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Constraint represented by a string, as it appears in the where-clause
14  * of an SQL query.
15  * <p>
16  * <em>This constraint type is provided for the sole purpose of aligning
17  * existing legacy code with the new search query framework, and will
18  * eventually be phased out.</em>
19  *
20  * @author Rob van Maris
21  * @version $Id: LegacyConstraint.java,v 1.2 2003/03/10 11:50:48 pierre Exp $
22  * @since MMBase-1.7
23  */
24 public interface LegacyConstraint extends Constraint {
25     
26     /**
27      * Gets the constraint.
28      *
29      * @return The constraint as it appears in the where-clause.
30      */
31     public String JavaDoc getConstraint();
32
33     /**
34      * Returns a string representation of this LegacyConstraint.
35      * The string representation has the form
36      * "LegacyConstraint(inverse:&lt:inverse&gt;, field:&lt;field&gt;,
37      * constraint:&lt;constraint&gt;)"
38      * where
39      * <ul>
40      * <li><em>&lt;inverse&gt;</em>is the value returned by
41      * {@link #isInverse isInverse()}
42      * <li><em>&lt;constraint&gt;</em> is the value returned by
43      * {@link #getConstraint getConstraint()}
44      * </ul>
45      *
46      * @return A string representation of this LegacyConstraint.
47      */
48     public String JavaDoc toString();
49 }
50
Popular Tags