Class IterableDataModel<E>
- java.lang.Object
-
- jakarta.faces.model.DataModel<E>
-
- jakarta.faces.model.IterableDataModel<E>
-
- All Implemented Interfaces:
Iterable<E>
public class IterableDataModel<E> extends DataModel<E>
IterableDataModel is an implementation of
DataModel
that wraps anIterable
.This can be used to encapsulate nearly every collection type, including
Collection
derived types such asList
andSet
. As such this specific DataModel can be used instead of more specific DataModels likeListDataModel
andCollectionDataModel
.
-
-
Constructor Summary
Constructors Constructor Description IterableDataModel()
Construct a newIterableDataModel
with no specified wrapped data.IterableDataModel(Iterable<E> iterable)
Construct a newIterableDataModel
wrapping the specified iterable.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getRowCount()
Return the number of rows of data objects represented by thisDataModel
.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.Object
getWrappedData()
Return the object representing the data wrapped by thisDataModel
, if any.boolean
isRowAvailable()
Return a flag indicating whether there isrowData
available at the currentrowIndex
.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(Object data)
Set the object representing the data collection wrapped by thisDataModel
.-
Methods inherited from class jakarta.faces.model.DataModel
addDataModelListener, getDataModelListeners, iterator, removeDataModelListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
IterableDataModel
public IterableDataModel()
Construct a new
IterableDataModel
with no specified wrapped data.
-
IterableDataModel
public IterableDataModel(Iterable<E> iterable)
Construct a new
IterableDataModel
wrapping the specified iterable.- Parameters:
iterable
- Iterable to be wrapped.
-
-
Method Detail
-
isRowAvailable
public boolean isRowAvailable()
Return a flag indicating whether there is
rowData
available at the currentrowIndex
. If nowrappedData
is available, returnfalse
.- Specified by:
isRowAvailable
in classDataModel<E>
- Returns:
- true if and only if there is data available at the current index, false otherwise.
- Throws:
FacesException
- if an error occurs getting the row availability
-
getRowCount
public int getRowCount()
Return the number of rows of data objects represented by this
DataModel
. If the number of rows is unknown, or nowrappedData
is available, return -1.- Specified by:
getRowCount
in classDataModel<E>
- Returns:
- the number of rows of data represented by this
DataModel
- Throws:
FacesException
- if an error occurs getting the row count
-
getRowData
public E getRowData()
Return an object representing the data for the currenty selected row index. If no
wrappedData
is available, returnnull
.- Specified by:
getRowData
in classDataModel<E>
- Returns:
- an object representing the data for the currently selected row index
- Throws:
FacesException
- if an error occurs getting the row dataIllegalArgumentException
- if now row data is available at the currently specified row index
-
getRowIndex
public 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.- Specified by:
getRowIndex
in classDataModel<E>
- Returns:
- the index of the currently selected row
- Throws:
FacesException
- if an error occurs getting the row index
-
setRowIndex
public 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 thegetRowData()
method.If there is no
wrappedData
available when this method is called, the specifiedrowIndex
is stored (and may be retrieved by a subsequent call togetRowData()
), but no event is sent. Otherwise, if the currently selected row index is changed by this call, aDataModelEvent
will be sent to therowSelected()
method of all registeredDataModelListener
s.- Specified by:
setRowIndex
in classDataModel<E>
- Parameters:
rowIndex
- The new zero-relative index (must be non-negative)- Throws:
FacesException
- if an error occurs setting the row indexIllegalArgumentException
- ifrowIndex
is less than -1
-
getWrappedData
public Object getWrappedData()
Return the object representing the data wrapped by this
DataModel
, if any.- Specified by:
getWrappedData
in classDataModel<E>
- Returns:
- the
Object
that this model wraps.
-
setWrappedData
public void setWrappedData(Object data)
Set the object representing the data collection wrapped by this
DataModel
. If the specifieddata
isnull
, detach thisDataModel
from any previously wrapped data collection instead.If
data
is non-null
, the currently selected row index must be set to zero, and aDataModelEvent
must be sent to therowSelected()
method of all registeredDataModelListener
s indicating that this row is now selected.- Specified by:
setWrappedData
in classDataModel<E>
- Parameters:
data
- Data collection to be wrapped, ornull
to detach from any previous data collection- Throws:
ClassCastException
- ifdata
is not of the appropriate type for thisDataModel
implementation
-
-