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.util.Locale;
045:
046: /**
047: * <p>The TableDataSorter interface defines a sort criteria and mechanism for
048: * sorting the contents of a {@link TableDataProvider}. The sort criteria
049: * is stored in an array of {@link SortCriteria} objects, and the sort operation
050: * is invoked via the {@link #sort(TableDataProvider,RowKey[])} method.
051: * </p>
052: *
053: * <p>NOTE: If a component is bound to a {@link TableDataProvider} and a
054: * TableDataSorter which are the *same* instance, the <code>sort(...)</code>
055: * method is never called. The sort order is assumed to be intrinsic in the
056: * row order of the {@link TableDataProvider}, based on the currently set sort
057: * criteria.</p>
058: *
059: * @see TableDataProvider
060: * @see SortCriteria
061: *
062: * @author Joe Nuxoll
063: */
064: public interface TableDataSorter {
065:
066: /**
067: * <p>Sets the sort criteria on this data sorter.</p>
068: *
069: * @param sortCriteria An array of {@link SortCriteria} objects defining
070: * the sort order on this TableDataSorter
071: */
072: public void setSortCriteria(SortCriteria[] sortCriteria);
073:
074: /**
075: * <p>Returns the current sort criteria on this data sorter.</p>
076: *
077: * @return SortCriteria[] defining the sort order on this TableDataSorter
078: */
079: public SortCriteria[] getSortCriteria();
080:
081: /**
082: * <p>Sets the sort locale to use when comparing objects. If none is set,
083: * the default locale should be used via <code>Locale.getDefault()</code>.
084: * </p>
085: *
086: * @param locale The desired Locale to use for sort comparisons
087: */
088: public void setSortLocale(Locale locale);
089:
090: /**
091: * <p>Gets the sort locale used when comparing objects. If none is set,
092: * the default locale should be used via <code>Locale.getDefault()</code>.
093: * </p>
094: *
095: * @return The Locale used for comparing objects, or null if the default
096: * Locale is used.
097: */
098: public Locale getSortLocale();
099:
100: /**
101: * <p>Sorts the rows from the specified {@link TableDataProvider} based on
102: * the current sort criteria, and returns an array of {@link RowKey}s
103: * representing the sorted row order. Any excluded rows from the return
104: * value of <code>sort(...)</code> should be considered unsortable, and thus
105: * should be displayed at the end of whatever UI is presenting these items.
106: * </p>
107: *
108: * <p>NOTE: If a component is bound to a {@link TableDataProvider} and
109: * an TableDataSorter, which are the *same* instance, this method is never
110: * called. The sort order is assumed to be intrinsic in the row key order
111: * of the {@link TableDataProvider}, based on the currently set sort
112: * criteria.</p>
113: *
114: * @param provider The {@link TableDataProvider} to sort
115: * @param rows The array of {@link RowKey}s to sort. If this is
116: * <code>null</code> then the return value should be
117: * <code>null</code> or an empty array of RowKeys.
118: * @return An array of {@link RowKey}s representing the sorted rows from
119: * the specified {@link TableDataProvider}. Any excluded rows
120: * from the return value of this method should be considered
121: * unsortable, and thus should be displayed at the end of whatever
122: * UI is presenting these items. <code>null</code> may be returned
123: * to indicate that sorting is not possible.
124: * @throws DataProviderException Implementations may wish to surface
125: * internal exceptions (nested in DataProviderException) rather
126: * than simply returning null or an empty array. A DPE may also
127: * indicate that the passed TableDataProvider or RowKeys are not
128: * valid. Consult the documentation of the specific TableDataSorter
129: * implementation for details on what exceptions might be wrapped by
130: * a DPE.
131: */
132: public RowKey[] sort(TableDataProvider provider, RowKey[] rows)
133: throws DataProviderException;
134: }
|