oracle.adf.view.faces.model
Class CollectionModel

java.lang.Object
  extended byjavax.faces.model.DataModel
      extended byoracle.adf.view.faces.model.CollectionModel
All Implemented Interfaces:
RowKeyIndex
Direct Known Subclasses:
SortableModel, TreeModel

public abstract class CollectionModel
extends DataModel
implements RowKeyIndex

The data model that is used by ADF Table components. This extends the faces DataModel class and adds on support for rowKeys and sorting.


Constructor Summary
CollectionModel()
           
 
Method Summary
 java.lang.Object getRowData(int rowIndex)
          Gets the rowData at the given index.
abstract  java.lang.Object getRowKey()
          Gets the rowKey of the current row.
 java.util.List getSortCriteria()
          Gets the criteria that this collection is sorted by.
 boolean isRowAvailable(int rowIndex)
          Checks to see if the row at the given index is available.
 boolean isSortable(java.lang.String property)
          Return true if this collection is sortable by the given property.
abstract  void setRowKey(java.lang.Object key)
          Finds the row with the matching key and makes it current
 void setSortCriteria(java.util.List criteria)
          Sorts this collection by the given criteria.
 
Methods inherited from class javax.faces.model.DataModel
addDataModelListener, getDataModelListeners, getRowCount, getRowData, getRowIndex, getWrappedData, isRowAvailable, removeDataModelListener, setRowIndex, setWrappedData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.adf.view.faces.model.RowKeyIndex
getRowCount, getRowData, getRowIndex, isRowAvailable, setRowIndex
 

Constructor Detail

CollectionModel

public CollectionModel()
Method Detail

getRowKey

public abstract java.lang.Object getRowKey()
Gets the rowKey of the current row. rowKeys are safer to use than row indices because rowKeys are unaffected by mutations to this collection. rowKeys should have efficient implementations of Object.equals(java.lang.Object) and Object.hashCode() as they will be used as keys in hashtables. rowKeys should also be Serializable, so that the application can run under all JSF state-saving schemes.

Specified by:
getRowKey in interface RowKeyIndex
Returns:
this key should be Serializable and immutable.
See Also:
setRowKey(java.lang.Object)

setRowKey

public abstract void setRowKey(java.lang.Object key)
Finds the row with the matching key and makes it current

Specified by:
setRowKey in interface RowKeyIndex
Parameters:
key - the rowKey, previously obtained from getRowKey().

isRowAvailable

public boolean isRowAvailable(int rowIndex)
Checks to see if the row at the given index is available. This method makes the given row current and calls DataModel.isRowAvailable(). Finally, the row that was current before this method was called is made current again.

Specified by:
isRowAvailable in interface RowKeyIndex
Parameters:
rowIndex - the index of the row to check.
Returns:
true if data for the row exists.

getRowData

public java.lang.Object getRowData(int rowIndex)
Gets the rowData at the given index. This method makes the given row current and calls DataModel.getRowData(). Finally, the row that was current before this method was called is made current again.

Specified by:
getRowData in interface RowKeyIndex
Parameters:
rowIndex - the index of the row to get data from.
Returns:
the data for the given row.

isSortable

public boolean isSortable(java.lang.String property)
Return true if this collection is sortable by the given property. This implementation always returns false;


getSortCriteria

public java.util.List getSortCriteria()
Gets the criteria that this collection is sorted by. This method should never return null. This implementation always returns an empty List.

Returns:
each element in this List is of type SortCriterion. An empty list is returned if this collection is not sorted.
See Also:
SortCriterion

setSortCriteria

public void setSortCriteria(java.util.List criteria)
Sorts this collection by the given criteria.

Parameters:
criteria - Each element in this List must be of type SortCriterion. The empty list may be used to cancel any sort order. null should be treated the same as an empty list.
See Also:
SortCriterion


Copyright © 2003-2006 Oracle Corporation. All Rights Reserved.