001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: /*
051: * CriteriaDAO.java
052: *
053: * Created on February 12, 2004, 11:39 AM
054: */
055:
056: package org.jaffa.beans.moulding.data.criteria;
057:
058: import org.jaffa.persistence.Criteria;
059:
060: /** The base class for all Criteria Data Access Objects.
061: *<p>
062: * This provides some common properties that are used by all Criteria objects.
063: * This includes such things as Max Rows to return and what fields/objects should
064: * be included in the resultant domain object graphs.
065: *
066: * @author PaulE
067: * @version 1.0
068: */
069: public abstract class CriteriaDAO {
070:
071: /** Holds value of property objectLimit. */
072: private Integer objectLimit = new Integer(25);
073:
074: /** Holds value of property resultGraphRules. */
075: private String[] resultGraphRules;
076:
077: /** Creates a new instance of CriteriaDAO */
078: public CriteriaDAO() {
079: }
080:
081: /** Getter for property objectLimit.
082: * @return Value of property objectLimit.
083: *
084: */
085: public Integer getObjectLimit() {
086: return this .objectLimit;
087: }
088:
089: /** Setter for property objectLimit.
090: * <p>
091: * This is the maximum root level object to be returned by the query. This
092: * is implemented as a safe guard to prevent 'runaway' queries that could
093: * try and bring back millions of rows.
094: * <p>
095: * Defaults to 25 objects any number below 1 implies ALL objects.
096: * @param objectLimit New value of property objectLimit.
097: *
098: */
099: public void setObjectLimit(Integer objectLimit) {
100: this .objectLimit = objectLimit;
101: }
102:
103: /**
104: * Return the real retrieve clause that will be executed for this query.
105: * <p>
106: * THIS MUST BE OVERRIDDEN BY THE SUPERCLASS
107: * @return return the generated clause
108: */
109: public abstract Criteria returnQueryClause();
110:
111: /** Getter for property resultGraphRules.
112: * @return Value of property resultGraphRules.
113: *
114: */
115: public String[] getResultGraphRules() {
116: return this .resultGraphRules;
117: }
118:
119: /** Setter for property resultGraphRules.
120: *<p>
121: * These rules control what fields and related objects should be included
122: * in the returned Domain Object Graph. By default only the top level object,
123: * and skeleton related foreign objects are included.
124: *<p>
125: * See <a href="./package-summary.html#howto">How to control what is returned in a
126: * domain object graph</a> for examples of how to use this to control what
127: * is returned in the output graph.
128: *<p>
129: * @param resultGraphRules New value of property resultGraphRules.
130: *
131: */
132: public void setResultGraphRules(String[] resultGraphRules) {
133: this.resultGraphRules = resultGraphRules;
134: }
135:
136: }
|