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: package org.jaffa.components.finder;
051:
052: import java.util.*;
053:
054: /**
055: * This is the base class for all the input DTOs used by the Finder components.
056: */
057: public class FinderInDto {
058:
059: /** Holds an array of OrderBy Fields to be used in the query. */
060: private List orderByFields;
061:
062: /** Determines the max records to be returned by the query. */
063: private Integer maxRecords;
064:
065: /** Creates an instance of this class.
066: */
067: public FinderInDto() {
068: orderByFields = new ArrayList();
069: }
070:
071: /** Add orderByFields.
072: * @param orderByFields OrderByFields.
073: */
074: public void addOrderByFields(OrderByField orderByFields) {
075: this .orderByFields.add(orderByFields);
076: }
077:
078: /** Add orderByFields at the specified position.
079: * @param orderByFields OrderByFields.
080: * @param index The position at which the orderByFields is to be added.
081: */
082: public void setOrderByFields(OrderByField orderByFields, int index) {
083: //-- check bounds for index
084: if ((index < 0) || (index > this .orderByFields.size()))
085: throw new IndexOutOfBoundsException();
086:
087: this .orderByFields.set(index, orderByFields);
088: }
089:
090: /** Add an array of orderByFields. This will overwrite existing orderByFields.
091: * @param orderByFields An array of orderByFields.
092: */
093: public void setOrderByFields(OrderByField[] orderByFields) {
094: this .orderByFields = Arrays.asList(orderByFields);
095: }
096:
097: /** Clear existing orderByFields.
098: */
099: public void clearOrderByFields() {
100: orderByFields.clear();
101: }
102:
103: /** Remove orderByFields.
104: * @param orderByFields OrderByFields.
105: * @return A true indicates a orderByFields was removed. A false indicates, the orderByFields was not found.
106: */
107: public boolean removeOrderByFields(OrderByField orderByFields) {
108: return this .orderByFields.remove(orderByFields);
109: }
110:
111: /** Returns a orderByFields from the specified position.
112: * @param index The position index.
113: * @return OrderByFields.
114: */
115: public OrderByField getOrderByFields(int index) {
116: //-- check bounds for index
117: if ((index < 0) || (index > orderByFields.size()))
118: throw new IndexOutOfBoundsException();
119:
120: return (OrderByField) orderByFields.get(index);
121: }
122:
123: /** Returns an array of orderByFields.
124: * @return An array of orderByFields.
125: */
126: public OrderByField[] getOrderByFields() {
127: return (OrderByField[]) orderByFields
128: .toArray(new OrderByField[0]);
129: }
130:
131: /** Returns a count of orderByFields.
132: * @return The count of orderByFields.
133: */
134: public int getOrderByFieldsCount() {
135: return orderByFields.size();
136: }
137:
138: /** Getter for property maxRecords.
139: * @return Value of property maxRecords.
140: */
141: public Integer getMaxRecords() {
142: return maxRecords;
143: }
144:
145: /** Setter for property maxRecords.
146: * @param maxRecords New value of property maxRecords.
147: */
148: public void setMaxRecords(Integer maxRecords) {
149: this.maxRecords = maxRecords;
150: }
151: }
|