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.impl;
043:
044: import com.sun.data.provider.DataProviderException;
045: import com.sun.data.provider.FieldKey;
046: import com.sun.data.provider.RowKey;
047: import com.sun.data.provider.SortCriteria;
048: import com.sun.data.provider.TableDataProvider;
049:
050: /**
051: * <p>The FieldKeySortCriteria class is an implementation of SortCriteria that
052: * simply retrieves the sort value from the {@link TableDataProvider} for the
053: * current {@link RowKey} using the specified {@link FieldKey}.</p>
054: *
055: * @author Joe Nuxoll
056: */
057: public class FieldKeySortCriteria extends SortCriteria {
058:
059: /**
060: * Constructs a FieldKeySortCriteria with no associated {@link FieldKey}.
061: */
062: public FieldKeySortCriteria() {
063: }
064:
065: /**
066: * Constructs a FieldKeySortCriteria with the specified {@link FieldKey}.
067: *
068: * @param fieldKey The desired FieldKey
069: */
070: public FieldKeySortCriteria(FieldKey fieldKey) {
071: this .fieldKey = fieldKey;
072: }
073:
074: /**
075: * Constructs a FieldKeySortCriteria with the specified {@link FieldKey} and
076: * ascending state.
077: *
078: * @param fieldKey The desired FieldKey
079: * @param ascending The desired boolean state for the ascending property
080: */
081: public FieldKeySortCriteria(FieldKey fieldKey, boolean ascending) {
082: this .fieldKey = fieldKey;
083: this .setAscending(ascending);
084: }
085:
086: /**
087: * Returns the FieldKey to use for this sort criteria.
088: *
089: * @return The currently set FieldKey for this sort criteria
090: */
091: public FieldKey getFieldKey() {
092: return fieldKey;
093: }
094:
095: /**
096: * Sets the FieldKey for this sort criteria.
097: *
098: * @param fieldKey The desired FieldKey for this sort criteria
099: */
100: public void setFieldKey(FieldKey fieldKey) {
101: this .fieldKey = fieldKey;
102: }
103:
104: /**
105: * <p>If no display name is set, this returns the {@link FieldKey}'s
106: * display name.</p>
107: *
108: * {@inheritDoc}
109: */
110: public String getDisplayName() {
111: String name = super .getDisplayName();
112: if ((name == null || "".equals(name)) && fieldKey != null) {
113: return fieldKey.getDisplayName();
114: }
115: return name;
116: }
117:
118: /**
119: * Returns the FieldKey's fieldId.
120: *
121: * {@inheritDoc}
122: */
123: public String getCriteriaKey() {
124: return fieldKey != null ? fieldKey.getFieldId() : ""; // NOI18N
125: }
126:
127: /**
128: * <p>Returns the value from the {@link TableDataProvider} stored under the
129: * {@link FieldKey} and {@link RowKey}.</p>
130: *
131: * {@inheritDoc}
132: */
133: public Object getSortValue(TableDataProvider provider, RowKey row)
134: throws DataProviderException {
135:
136: return provider.getValue(fieldKey, row);
137: }
138:
139: private FieldKey fieldKey;
140: }
|