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