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.metadata;
051:
052: import org.jaffa.datatypes.*;
053: import org.jaffa.util.LocaleHelper;
054:
055: /**
056: * An instance of this class will hold meta information for a DateOnly field.
057: */
058: public class DateOnlyFieldMetaData extends FieldMetaData {
059:
060: /** Default width.*/
061: public static final int DEFAULT_WIDTH = 20;
062: /** Default Layout To Use for Formatting a DateOnly object into a String.*/
063: //private static final String DEFAULT_FORMAT_LAYOUT = "MM/dd/yyyy";
064: //public static final String DEFAULT_FORMAT_LAYOUT = localeFormat.LocaleHelper("dateonly.format");
065: /** Default Layout To Use for Parsing a String into a DateOnly object.*/
066: //private static final String DEFAULT_PARSE_LAYOUT = "MM/dd/yy";
067: //public static final String DEFAULT_PARSE_LAYOUT = localeFormat.LocaleHelper("dateonly.parse");
068: // NOTE: keep the equals(), clone(), compareTo(), hashCode() methods in sync
069: private String m_layout = null;
070: private DateOnly m_minValue = null;
071: private DateOnly m_maxValue = null;
072:
073: /** Creates an instance.
074: */
075: public DateOnlyFieldMetaData() {
076: super (null, Defaults.DATEONLY, null, null);
077: }
078:
079: /** Creates an instance.
080: * @param name The field name.
081: * @param labelToken The token used for displaying labels.
082: * @param isMandatory Indicates if the field is mandatory.
083: * @param layout The layout.
084: * @param minValue The minimum value.
085: * @param maxValue The maximum value.
086: */
087: public DateOnlyFieldMetaData(String name, String labelToken,
088: Boolean isMandatory, String layout, DateOnly minValue,
089: DateOnly maxValue) {
090: super (name, Defaults.DATEONLY, labelToken, isMandatory);
091: m_layout = layout;
092: m_minValue = minValue;
093: m_maxValue = maxValue;
094: }
095:
096: /** Getter for property layout.
097: * @return Value of property layout.
098: */
099: public String getLayout() {
100: return m_layout;
101: }
102:
103: /** Getter for property minValue.
104: * @return Value of property minValue.
105: */
106: public DateOnly getMinValue() {
107: return m_minValue;
108: }
109:
110: /** Getter for property maxValue.
111: * @return Value of property maxValue.
112: */
113: public DateOnly getMaxValue() {
114: return m_maxValue;
115: }
116:
117: /** Returns a clone of the object.
118: * @return a clone of the object.
119: */
120: public Object clone() {
121: // no more processing required since the fields are immutable
122: return super .clone();
123: }
124:
125: /** Returns the hash code.
126: * @return the hash code.
127: */
128: public int hashCode() {
129: int i = 0;
130: i = super .hashCode();
131: if (m_layout != null)
132: i += m_layout.hashCode();
133: if (m_minValue != null)
134: i += m_minValue.hashCode();
135: if (m_minValue != null)
136: i += m_maxValue.hashCode();
137: return i;
138: }
139:
140: /** Compares this object with another DateOnlyMetaData object.
141: * Returns a true if both the objects have the same properties.
142: * @param obj the other DateOnlyFieldMetaData object.
143: * @return a true if both the objects have the same properties.
144: */
145: public boolean equals(Object obj) {
146: boolean isEqual = false;
147: if (obj instanceof DateOnlyFieldMetaData) {
148: DateOnlyFieldMetaData field2 = (DateOnlyFieldMetaData) obj;
149: if (super .equals(field2)) {
150: if (((m_layout != null && m_layout
151: .equals(field2.m_layout)) || (m_layout == null && field2.m_layout == null))
152: && ((m_minValue != null && m_minValue
153: .equals(field2.m_minValue)) || (m_minValue == null && field2.m_minValue == null))
154: && ((m_maxValue != null && m_maxValue
155: .equals(field2.m_maxValue)) || (m_maxValue == null && field2.m_maxValue == null)))
156: isEqual = true;
157: }
158: }
159: return isEqual;
160: }
161:
162: /** Compares this object with another DateOnlyFieldMetaData object.
163: * Note: this class has a natural ordering that is inconsistent with equals
164: * @param obj the other DateOnlyFieldMetaData object.
165: * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
166: */
167: public int compareTo(Object obj) {
168: // NOTE: this isnt a perfect compare !!!
169: return super .compareTo(obj);
170: }
171:
172: /** Returns the diagnostic information.
173: * @return the diagnostic information.
174: */
175: public String toString() {
176: String comma = ", ";
177: String equals = "=";
178: StringBuffer buffer = new StringBuffer(super .toString());
179:
180: buffer.append(comma);
181: buffer.append("Layout");
182: buffer.append(equals);
183: buffer.append(m_layout);
184: buffer.append(comma);
185: buffer.append("MinValue");
186: buffer.append(equals);
187: buffer.append(m_minValue);
188: buffer.append(comma);
189: buffer.append("MaxValue");
190: buffer.append(equals);
191: buffer.append(m_maxValue);
192:
193: return buffer.toString();
194: }
195:
196: /** Getter for property width.
197: * @return Value of property width.
198: */
199: public int getWidth() {
200: return DEFAULT_WIDTH;
201: }
202:
203: /** Returns an equivalent DateTimeFieldMetaData object.
204: * @return an equivalent DateTimeFieldMetaData object.
205: */
206: public DateTimeFieldMetaData toDateTimeFieldMetaData() {
207: String name = getName();
208: String labelToken = getLabelToken();
209: Boolean isMandatory = isMandatory();
210: String layout = getLayout();
211: DateTime minValue = m_minValue == null ? null : DateOnly
212: .toDateTime(m_minValue);
213: DateTime maxValue = m_maxValue == null ? null : DateOnly
214: .toDateTime(m_maxValue);
215:
216: return new DateTimeFieldMetaData(name, labelToken, isMandatory,
217: layout, minValue, maxValue);
218: }
219:
220: public static String getDateOnlyParse() {
221: return LocaleHelper.getProperty("dateonly.parse");
222: }
223:
224: public static String getDateOnlyFormat() {
225: return LocaleHelper.getProperty("dateonly.format");
226: }
227:
228: }
|