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: import org.apache.log4j.Logger;
054: import org.jaffa.metadata.StringFieldMetaData;
055: import org.jaffa.datatypes.Parser;
056: import org.jaffa.util.StringHelper;
057:
058: /**
059: * This class will be used by the Finder components to hold a String criteria.
060: */
061: public class StringCriteriaField implements CriteriaField {
062:
063: private static final Logger log = Logger
064: .getLogger(StringCriteriaField.class);
065: private String m_operator = null;
066: private List m_values = null;
067:
068: /** Adds a Criteria.
069: * @param operator the operator of the criteria.
070: * @param value the value of the criteria.
071: * @throws IllegalArgumentException if the operator is null. The exception will also be thrown if the value is null and the operator is neither 'IsNull' nor 'IsNotNull'.
072: */
073: public StringCriteriaField(String operator, String value)
074: throws IllegalArgumentException {
075: this (operator, value != null ? new String[] { value } : null);
076: }
077:
078: /** Adds a Criteria.
079: * @param operator the operator of the criteria.
080: * @param values the value array of the criteria.
081: * @throws IllegalArgumentException if the operator is null. The exception will also be thrown if the value is null and the operator is neither 'IsNull' nor 'IsNotNull'.
082: */
083: public StringCriteriaField(String operator, String[] values)
084: throws IllegalArgumentException {
085: if (operator == null) {
086: String str = "StringCriteriaField operator cannot be null";
087: log.error(str);
088: throw new IllegalArgumentException(str);
089: } else if (values == null || values.length == 0) {
090: if (!operator.equals(CriteriaField.RELATIONAL_IS_NULL)
091: && !operator
092: .equals(CriteriaField.RELATIONAL_IS_NOT_NULL)) {
093: String str = "StringCriteriaField value cannot be null";
094: log.error(str);
095: throw new IllegalArgumentException(str);
096: }
097: }
098:
099: m_operator = operator;
100: if (values != null)
101: m_values = Arrays.asList(values);
102: }
103:
104: /** Getter for property operator.
105: * @return Value of property operator.
106: */
107: public String getOperator() {
108: return m_operator;
109: }
110:
111: /** Getter for property values.
112: * This basically invokes the getValues() method.
113: * @return An array of values for the Criteria.
114: */
115: public Object[] returnValuesAsObjectArray() {
116: return getValues();
117: }
118:
119: /** Getter for property values.
120: * @return An array of values for the Criteria.
121: */
122: public String[] getValues() {
123: return m_values != null ? (String[]) m_values
124: .toArray(new String[0]) : null;
125: }
126:
127: /** Returns diagnostic information.
128: * @return diagnostic information.
129: */
130: public String toString() {
131: StringBuffer buf = new StringBuffer("<StringCriteriaField>");
132: buf.append("<operator>");
133: if (m_operator != null)
134: buf.append(m_operator);
135: buf.append("</operator>");
136: if (m_values != null) {
137: for (Iterator i = m_values.iterator(); i.hasNext();) {
138: Object value = i.next();
139: buf.append("<value>");
140: if (value != null)
141: buf.append(value);
142: buf.append("</value>");
143: }
144: }
145: buf.append("</StringCriteriaField>");
146: return buf.toString();
147: }
148:
149: /** This will generate a CriteriaField object based on the input parameters.
150: * @param operator The operator of the criteria.
151: * @param value The value for the criteria. Multiple values should be separated by comma.
152: * @param meta The FieldMetaData object to obtain the layout for parsing.
153: * @return a CriteriaField object based on the input parameters.
154: */
155: public static StringCriteriaField getStringCriteriaField(
156: String operator, String value, StringFieldMetaData meta) {
157: StringCriteriaField criteriaField = null;
158: String nullValue = null;
159:
160: if (value != null)
161: value = value.trim();
162:
163: if (value != null && value.length() > 0) {
164: List values = new ArrayList();
165: if (RELATIONAL_BETWEEN.equals(operator)
166: || RELATIONAL_IN.equals(operator)) {
167: // replace ",," with ", ,"
168: value = StringHelper.replace(value,
169: CONSECUTIVE_SEPARATORS,
170: CONSECUTIVE_SEPARATORS_WITH_SPACE);
171:
172: if (value
173: .startsWith(SEPARATOR_FOR_IN_BETWEEN_OPERATORS))
174: values.add(null);
175:
176: StringTokenizer tknzr = new StringTokenizer(value,
177: SEPARATOR_FOR_IN_BETWEEN_OPERATORS);
178: while (tknzr.hasMoreTokens())
179: parseAndAdd(tknzr.nextToken().trim(), meta, values);
180:
181: if (value.endsWith(SEPARATOR_FOR_IN_BETWEEN_OPERATORS))
182: values.add(null);
183: } else {
184: parseAndAdd(value, meta, values);
185: }
186: if (values.size() > 0)
187: criteriaField = new StringCriteriaField(operator,
188: (String[]) values.toArray(new String[0]));
189: else
190: criteriaField = new StringCriteriaField(operator,
191: nullValue);
192: } else
193: criteriaField = new StringCriteriaField(operator, nullValue);
194: return criteriaField;
195: }
196:
197: private static void parseAndAdd(String str,
198: StringFieldMetaData meta, List values) {
199: if (str != null && str.length() > 0)
200: values.add(Parser.parseString(str));
201: else
202: values.add(null);
203: }
204:
205: /** Default constructor.
206: * NOTE: This was added to support tools, which create instances of this class by bean introspection. In all other cases, it is recommended to use the static methods to instantiate this class.
207: */
208: public StringCriteriaField() {
209: m_operator = null;
210: m_values = null;
211: }
212:
213: /** Setter for the property operator.
214: * NOTE: This was added to support tools, which create instances of this class by bean introspection. In all other cases, it is recommended to use the static methods to instantiate this class.
215: * @param operator The value of the property operator.
216: */
217: public void setOperator(String operator) {
218: m_operator = operator;
219: }
220:
221: /** Setter for the property values.
222: * NOTE: This was added to support tools, which create instances of this class by bean introspection. In all other cases, it is recommended to use the static methods to instantiate this class.
223: * @param values The value of the property values.
224: */
225: public void setValues(String[] values) {
226: if (values != null) {
227: m_values = new ArrayList();
228: for (int i = 0; i < values.length; i++) {
229: Object value = values[i];
230: m_values.add(value);
231: }
232: } else {
233: m_values = null;
234: }
235: }
236:
237: }
|