| java.lang.Object
 com.sun.data.provider.SortCriteria
All known Subclasses: com.sun.data.provider.impl.FieldIdSortCriteria, com.sun.data.provider.impl.FieldKeySortCriteria, com.sun.rave.web.ui.faces.ValueBindingSortCriteria, com.sun.rave.web.ui.faces.ValueExpressionSortCriteria,
| Method Summary | |
| abstract public String | getCriteriaKey()
Returns a String uniquely identifying this sort criteria. | | public String | getDisplayName()
| | abstract public Object | getSortValue(TableDataProvider provider, RowKey rowKey)
Provides the data value to use while sorting a particular row.
Implementations may perform whatever logic is desired to provide the
data object to represent this row in a sort.
Parameters:
provider - TableDataProvider containing the data on display
Parameters:
rowKey - The RowKey of the row to be sorted the data object representing this row for this sort criteria
throws:
DataProviderException - Implementations may wish to surfaceinternal exceptions (nested in DataProviderException) ratherthan simply returning null. | | public boolean | isAscending()
| | public void | setAscending(boolean ascending)
| | public void | setDisplayName(String displayName)
|
| SortCriteria | | public SortCriteria()(Code) | | Constructs a new SortCriteria object with no display name and the
default state for include (true).
|
| SortCriteria | | public SortCriteria(String displayName)(Code) | | Constructs a new SortCriteria object with the specified display name
and the default state for the include/exclude (true ==
include).
Parameters:
displayName - The desired display name for this filter criteria |
| SortCriteria | | public SortCriteria(String displayName, boolean ascending)(Code) | | Constructs a new SortCriteria object with the specified display name
and state for include/exclude (true == include).
Parameters:
displayName - The desired display name for this filter criteria
Parameters:
ascending - true for ascending sort, orfalse for descending. |
| getCriteriaKey | | abstract public String getCriteriaKey()(Code) | | Returns a String uniquely identifying this sort criteria. This is used
to match up a sort criteria object with a user gesture in UI.
A String that uniquely identifies this sort criteria |
| getDisplayName | | public String getDisplayName()(Code) | | Returns the display name for this sort criteria.
The display name of this sort criteria |
| getSortValue | | abstract public Object getSortValue(TableDataProvider provider, RowKey rowKey) throws DataProviderException(Code) | | Provides the data value to use while sorting a particular row.
Implementations may perform whatever logic is desired to provide the
data object to represent this row in a sort.
Parameters:
provider - TableDataProvider containing the data on display
Parameters:
rowKey - The RowKey of the row to be sorted the data object representing this row for this sort criteria
throws:
DataProviderException - Implementations may wish to surfaceinternal exceptions (nested in DataProviderException) ratherthan simply returning null. A DPE may also indicate that thepassed TableDataProvider or RowKey is not valid. Consult thedocumentation of the specific SortCriteria implementation fordetails on what exceptions might be wrapped by a DPE. |
| isAscending | | public boolean isAscending()(Code) | | Returns the ascending sort state for this SortCriteria
true for ascending, false fordescending |
| setAscending | | public void setAscending(boolean ascending)(Code) | | Sets the ascending sort state for this SortCriteria
Parameters:
ascending - true for ascending, falsefor desscending |
| setDisplayName | | public void setDisplayName(String displayName)(Code) | | Sets the display name for this filter criteria.
Parameters:
displayName - The desired display name for this filter criteria |
|
|