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: /**
053: * This class is used to encapsulate an element used in the OrderBy clause of a query.
054: */
055: public class OrderByField {
056:
057: /** Holds value of property fieldName. */
058: private String fieldName;
059:
060: /** Holds value of property sortAscending. */
061: private Boolean sortAscending;
062:
063: /** Creates an instance of this class.
064: */
065: public OrderByField() {
066: this (null);
067: }
068:
069: /** Creates an instance of this class.
070: * @param fieldName the value of property fieldName.
071: */
072: public OrderByField(String fieldName) {
073: this (fieldName, Boolean.TRUE);
074: }
075:
076: /** Creates an instance of this class.
077: * @param fieldName the value of property fieldName.
078: * @param sortAscending the value of property sortAscending.
079: */
080: public OrderByField(String fieldName, Boolean sortAscending) {
081: this .fieldName = fieldName;
082: this .sortAscending = sortAscending;
083: }
084:
085: /** Getter for property fieldName.
086: * @return Value of property fieldName.
087: */
088: public String getFieldName() {
089: return fieldName;
090: }
091:
092: /** Setter for property fieldName.
093: * @param fieldName New value of property fieldName.
094: */
095: public void setFieldName(String fieldName) {
096: this .fieldName = fieldName;
097: }
098:
099: /** Getter for property sortAscending.
100: * @return Value of property sortAscending.
101: */
102: public Boolean getSortAscending() {
103: return sortAscending;
104: }
105:
106: /** Setter for property sortAscending.
107: * @param sortAscending New value of property sortAscending.
108: */
109: public void setSortAscending(Boolean sortAscending) {
110: this .sortAscending = sortAscending;
111: }
112:
113: /** Returns diagnostic information.
114: * @return diagnostic information.
115: */
116: public String toString() {
117: StringBuffer buf = new StringBuffer("<OrderByField>");
118: buf.append("<fieldName>");
119: if (fieldName != null)
120: buf.append(fieldName);
121: buf.append("</fieldName>");
122: buf.append("<sortAscending>");
123: if (sortAscending != null)
124: buf.append(sortAscending);
125: buf.append("</sortAscending>");
126: buf.append("</OrderByField>");
127: return buf.toString();
128: }
129: }
|