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.Defaults;
053:
054: /**
055: * An instance of this class will hold meta information for a Boolean field.
056: */
057: public class BooleanFieldMetaData extends FieldMetaData {
058:
059: /** The default width.*/
060: public static final int DEFAULT_WIDTH = 2;
061:
062: /** The default layout.*/
063: public static final String DEFAULT_LAYOUT = null;
064:
065: /** The default pattern.*/
066: public static final String DEFAULT_PATTERN = null;
067:
068: // NOTE: keep the equals(), clone(), compareTo(), hashCode() methods in sync
069: private String m_layout = null;
070: private String m_pattern = null;
071:
072: /** Creates an instance.
073: * @param name The field name.
074: * @param labelToken The token used for displaying labels.
075: * @param isMandatory Indicates if the field is mandatory.
076: * @param layout The layout.
077: * @param pattern The pattern.
078: */
079: public BooleanFieldMetaData(String name, String labelToken,
080: Boolean isMandatory, String layout, String pattern) {
081: super (name, Defaults.BOOLEAN, labelToken, isMandatory);
082: m_layout = layout;
083: m_pattern = pattern;
084: }
085:
086: /** Getter for property layout.
087: * @return Value of property layout.
088: */
089: public String getLayout() {
090: return m_layout;
091: }
092:
093: /** Getter for property pattern.
094: * @return Value of property pattern.
095: */
096: public String getPattern() {
097: return m_pattern;
098: }
099:
100: /** Returns a clone of the object.
101: * @return a clone of the object.
102: */
103: public Object clone() {
104: // no more processing required since the fields are immutable
105: return super .clone();
106: }
107:
108: /** Returns the hash code.
109: * @return the hash code.
110: */
111: public int hashCode() {
112: int i = 0;
113: i = super .hashCode();
114: if (m_layout != null)
115: i += m_layout.hashCode();
116: if (m_pattern != null)
117: i += m_pattern.hashCode();
118: return i;
119: }
120:
121: /** Compares this object with another BooleanFieldMetaData object.
122: * Returns a true if both the objects have the same properties.
123: * @param obj the other BooleanFieldMetaData object.
124: * @return a true if both the objects have the same properties.
125: */
126: public boolean equals(Object obj) {
127: boolean isEqual = false;
128: if (obj instanceof BooleanFieldMetaData) {
129: BooleanFieldMetaData field2 = (BooleanFieldMetaData) obj;
130: if (super .equals(field2)) {
131: if (((m_layout != null && m_layout
132: .equals(field2.m_layout)) || (m_layout == null && field2.m_layout == null))
133: && ((m_pattern != null && m_pattern
134: .equals(field2.m_pattern)) || (m_pattern == null && field2.m_pattern == null)))
135: isEqual = true;
136: }
137: }
138: return isEqual;
139: }
140:
141: /** Compares this object with another BooleanFieldMetaData object.
142: * Note: this class has a natural ordering that is inconsistent with equals
143: * @param obj the other BooleanFieldMetaData object.
144: * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
145: */
146: public int compareTo(Object obj) {
147: // NOTE: this isnt a perfect compare !!!
148: return super .compareTo(obj);
149: }
150:
151: /** Returns the diagnostic information.
152: * @return the diagnostic information.
153: */
154: public String toString() {
155: String comma = ", ";
156: String equals = "=";
157: StringBuffer buffer = new StringBuffer(super .toString());
158:
159: buffer.append(comma);
160: buffer.append("Layout");
161: buffer.append(equals);
162: buffer.append(m_layout);
163: buffer.append(comma);
164: buffer.append("Pattern");
165: buffer.append(equals);
166: buffer.append(m_pattern);
167:
168: return buffer.toString();
169: }
170:
171: /** Getter for property width.
172: * @return Value of property width.
173: */
174: public int getWidth() {
175: return DEFAULT_WIDTH;
176: }
177: }
|