Source Code Cross Referenced for LegacyConstraint.java in  » Database-ORM » MMBase » org » mmbase » storage » search » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:
03:        This software is OSI Certified Open Source Software.
04:        OSI Certified is a certification mark of the Open Source Initiative.
05:
06:        The license (Mozilla version 1.0) can be read at the MMBase site.
07:        See http://www.MMBase.org/license
08:
09:         */
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.3 2007/12/06 08:13:36 michiel 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 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 toString();
49:        }