001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package com.sun.data.provider;
043:
044: import java.io.Serializable;
045:
046: /**
047: * <p>FieldKey is a representation of an identifier for a specific data
048: * element that may be retrieved from a {@link DataProvider}. Specialized
049: * implementations might also provide extra capabilities for navigation
050: * between elements, or other value added services.</p>
051: *
052: * <p>FieldKey implements Comparable, to allow for sorting based on the
053: * displayName of the FieldKey. Note that the Comparable equals test may
054: * not correspond to the FieldKey.equals(...) test, as the Comparable
055: * implementation is working with the displayName, while the equals(...)
056: * method works with the fieldId.</p>
057: *
058: * @author Joe Nuxoll
059: * @author Craig McClanahan
060: */
061: public class FieldKey implements Comparable, Serializable {
062:
063: /**
064: * A convenient static empty array to use for no-op method returns
065: */
066: public static final FieldKey[] EMPTY_ARRAY = new FieldKey[0];
067:
068: /**
069: * Constructs a new FieldKey with the specified canonical ID.
070: *
071: * @param fieldId The desired canonical ID String
072: */
073: public FieldKey(String fieldId) {
074: this .fieldId = fieldId;
075: this .displayName = this .fieldId;
076: }
077:
078: /**
079: * Constructs a new FieldKey with the specified canonical ID and display
080: * name.
081: *
082: * @param fieldId The desired canonical ID String for this field
083: * @param displayName The desired display name String
084: */
085: public FieldKey(String fieldId, String displayName) {
086: this .fieldId = fieldId;
087: this .displayName = displayName;
088: }
089:
090: /**
091: * @param fieldId the canonical internal identifier of this {@link FieldKey}
092: */
093: public void setFieldId(String fieldId) {
094: this .fieldId = fieldId;
095: }
096:
097: /**
098: * @return the canonical internal identifier of this {@link FieldKey}
099: */
100: public String getFieldId() {
101: return fieldId;
102: }
103:
104: /**
105: * @param displayName The display name for this data element, suitable for
106: * inclusion in a menu of available options.
107: */
108: public void setDisplayName(String displayName) {
109: this .displayName = displayName;
110: }
111:
112: /**
113: * @return the display name for this data element, suitable for
114: * inclusion in a menu of available options.
115: */
116: public String getDisplayName() {
117: return displayName;
118: }
119:
120: /**
121: * Standard equals implementation. This method compares the FieldKey id
122: * values for equality.
123: *
124: * @param o the Object to check equality
125: * @return true if equal, false if not
126: * @see Object#equals(Object)
127: */
128: public boolean equals(Object o) {
129: if (o instanceof FieldKey) {
130: String fkFieldId = ((FieldKey) o).getFieldId();
131: String this FieldId = getFieldId();
132: return this FieldId == fkFieldId
133: || (this FieldId != null && this FieldId
134: .equals(fkFieldId));
135: }
136: return false;
137: }
138:
139: /**
140: * @return the hashCode of a blank String if the FieldKey id is null, or the
141: * hashCode of the FieldKey id otherwise.
142: * @see Object#hashCode()
143: */
144: public int hashCode() {
145: String this FieldId = getFieldId();
146: if (this FieldId == null) {
147: return "".hashCode();
148: }
149: return this FieldId.hashCode();
150: }
151:
152: /**
153: * Standard compareTo implementation (for {@link Comparable} interface).
154: * This method compares FieldKeys for sorting by comparing the displayName
155: * values.
156: *
157: * @param o Object to compare
158: * @return a negative integer, zero, or a positive integer as this object
159: * is less than, equal to, or greater than the specified object.
160: * @see Comparable#compareTo(Object)
161: */
162: public int compareTo(Object o) {
163: String this DisplayName = getDisplayName();
164: if (o instanceof FieldKey && this DisplayName != null) {
165: String fkDisplayName = ((FieldKey) o).getDisplayName();
166: return this DisplayName.compareTo(fkDisplayName);
167: }
168: return 0;
169: }
170:
171: private String fieldId;
172: private String displayName;
173:
174: public String toString() {
175: return "FieldKey[" + getFieldId() + "]"; // NOI18N
176: }
177: }
|