Class ListDataModel<E>
- All Implemented Interfaces:
Iterable<E>
public class ListDataModel<E> extends DataModel<E>
ListDataModel is a convenience implementation of DataModel
that wraps an List
of Java objects.
-
Constructor Summary
Constructors Constructor Description ListDataModel()
Construct a newListDataModel
with no specified wrapped data.ListDataModel(List<E> list)
Construct a newListDataModel
wrapping the specified list. -
Method Summary
Modifier and Type Method Description int
getRowCount()
If there iswrappedData
available, return the length of the list.E
getRowData()
If row data is available, return the array element at the index specified byrowIndex
.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()
Returntrue
if there iswrappedData
available, and the current value ofrowIndex
is greater than or equal to zero, and less than the size of the list.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
-
Constructor Details
-
ListDataModel
public ListDataModel()Construct a new
ListDataModel
with no specified wrapped data. -
ListDataModel
Construct a new
ListDataModel
wrapping the specified list.- Parameters:
list
- List to be wrapped (if any)
-
-
Method Details
-
isRowAvailable
public boolean isRowAvailable()Return
true
if there iswrappedData
available, and the current value ofrowIndex
is greater than or equal to zero, and less than the size of the list. Otherwise, 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()If there is
wrappedData
available, return the length of the list. If 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
If row data is available, return the array element at the index specified by
rowIndex
. If no wrapped data 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()Description copied from class:DataModel
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)Description copied from class:DataModel
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
Description copied from class:DataModel
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
Description copied from class:DataModel
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 non-null
and is not aList
-