public class IterableDataModel<E> extends DataModel<E>
IterableDataModel is an implementation of DataModel
that wraps an Iterable
.
This can be used to encapsulate nearly every collection type, including Collection
derived types such as
List
and Set
. As such this specific DataModel can be used instead of more specific DataModels like
ListDataModel
and CollectionDataModel
.
Constructor and Description |
---|
IterableDataModel()
Construct a new
IterableDataModel with no specified wrapped data. |
IterableDataModel(java.lang.Iterable<E> iterable)
Construct a new
IterableDataModel wrapping the specified iterable. |
Modifier and Type | Method and Description |
---|---|
int |
getRowCount()
Return the number of rows of data objects represented by this
DataModel . |
E |
getRowData()
Return an object representing the data for the currenty selected row index.
|
int |
getRowIndex()
Return the zero-relative index of the currently selected row.
|
java.lang.Object |
getWrappedData()
Return the object representing the data wrapped by this
DataModel , if any. |
boolean |
isRowAvailable()
Return a flag indicating whether there is
rowData available at the current rowIndex . |
void |
setRowIndex(int rowIndex)
Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.
|
void |
setWrappedData(java.lang.Object data)
Set the object representing the data collection wrapped by this
DataModel . |
addDataModelListener, getDataModelListeners, iterator, removeDataModelListener
public IterableDataModel()
Construct a new IterableDataModel
with no specified wrapped data.
public IterableDataModel(java.lang.Iterable<E> iterable)
Construct a new IterableDataModel
wrapping the specified iterable.
iterable
- Iterable to be wrapped.public boolean isRowAvailable()
Return a flag indicating whether there is rowData
available at the current rowIndex
. If no
wrappedData
is available, return false
.
isRowAvailable
in class DataModel<E>
FacesException
- if an error occurs getting the row availabilitypublic int getRowCount()
Return the number of rows of data objects represented by this DataModel
. If the number of rows is unknown, or
no wrappedData
is available, return -1.
getRowCount
in class DataModel<E>
DataModel
FacesException
- if an error occurs getting the row countpublic E getRowData()
Return an object representing the data for the currenty selected row index. If no wrappedData
is
available, return null
.
getRowData
in class DataModel<E>
FacesException
- if an error occurs getting the row datajava.lang.IllegalArgumentException
- if now row data is available at the currently specified row indexpublic int getRowIndex()
Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no
wrappedData
is available, return -1.
getRowIndex
in class DataModel<E>
FacesException
- if an error occurs getting the row indexpublic void setRowIndex(int rowIndex)
Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It
is possible to set the row index at a value for which the underlying data collection does not contain any row data.
Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for
use by the getRowData()
method.
If there is no wrappedData
available when this method is called, the specified rowIndex
is
stored (and may be retrieved by a subsequent call to getRowData()
), but no event is sent. Otherwise, if
the currently selected row index is changed by this call, a DataModelEvent
will be sent to the
rowSelected()
method of all registered DataModelListener
s.
setRowIndex
in class DataModel<E>
rowIndex
- The new zero-relative index (must be non-negative)FacesException
- if an error occurs setting the row indexjava.lang.IllegalArgumentException
- if rowIndex
is less than -1public java.lang.Object getWrappedData()
Return the object representing the data wrapped by this DataModel
, if any.
getWrappedData
in class DataModel<E>
Object
that this model wraps.public void setWrappedData(java.lang.Object data)
Set the object representing the data collection wrapped by this DataModel
. If the specified data
is null
, detach this DataModel
from any previously wrapped data collection instead.
If data
is non-null
, the currently selected row index must be set to zero, and a
DataModelEvent
must be sent to the rowSelected()
method of all registered
DataModelListener
s indicating that this row is now selected.
setWrappedData
in class DataModel<E>
data
- Data collection to be wrapped, or null
to detach from any previous data collectionjava.lang.ClassCastException
- if data
is not of the appropriate type for this DataModel
implementation