Top Description Fields Constructors Methods
jakarta.faces.model

public Class CollectionDataModel<E>

extends DataModel<E>
Class Inheritance
Imports
java.util.Collection

CollectionDataModel is a convenience implementation of DataModel that wraps an Collection of Java objects.

Field Summary

Modifier and TypeField and Description
private E[]
arrayFromInner

private int
index

private Collection<E>
inner

Constructor Summary

AccessConstructor and Description
public
CollectionDataModel()

Construct a new CollectionDataModel with no specified wrapped data.

public
CollectionDataModel(Collection<E>
Collection to be wrapped.
collection)

Construct a new CollectionDataModel wrapping the specified list.

Method Summary

Modifier and TypeMethod and Description
public int
getRowCount()

Implements abstract jakarta.faces.model.DataModel.getRowCount.

If there is wrappedData available, return the length of the list.

public E
getRowData()

Implements abstract jakarta.faces.model.DataModel.getRowData.

If row data is available, return the array element at the index specified by rowIndex.

public int
getRowIndex()

Implements abstract jakarta.faces.model.DataModel.getRowIndex.

Return the zero-relative index of the currently selected row.

public Object
getWrappedData()

Implements abstract jakarta.faces.model.DataModel.getWrappedData.

Return the object representing the data wrapped by this DataModel, if any.

public boolean
isRowAvailable()

Implements abstract jakarta.faces.model.DataModel.isRowAvailable.

Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list.

public void
setRowIndex(int
The new zero-relative index (must be non-negative)
rowIndex)

Implements abstract jakarta.faces.model.DataModel.setRowIndex.

Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.

public void
setWrappedData(Object
the wrapped data.
data)

Implements abstract jakarta.faces.model.DataModel.setWrappedData.

Set the wrapped data.

Inherited from jakarta.faces.model.DataModel:
addDataModelListenergetDataModelListenersiteratorremoveDataModelListener

Field Detail

arrayFromInnerback to summary
private E[] arrayFromInner
indexback to summary
private int index
innerback to summary
private Collection<E> inner

Constructor Detail

CollectionDataModelback to summary
public CollectionDataModel()

Construct a new CollectionDataModel with no specified wrapped data.

CollectionDataModelback to summary
public CollectionDataModel(Collection<E> collection)

Construct a new CollectionDataModel wrapping the specified list.

Parameters
collection:Collection<E>

Collection to be wrapped.

Method Detail

getRowCountback to summary
public int getRowCount()

Implements abstract jakarta.faces.model.DataModel.getRowCount.

If there is wrappedData available, return the length of the list. If no wrappedData is available, return -1.

Returns:int

Doc from jakarta.faces.model.DataModel.getRowCount.

the number of rows of data represented by this DataModel

Annotations
@Override
Exceptions
FacesException:
if an error occurs getting the row count
getRowDataback to summary
public E getRowData()

Implements abstract jakarta.faces.model.DataModel.getRowData.

If row data is available, return the array element at the index specified by rowIndex. If no wrapped data is available, return null.

Returns:E

Doc from jakarta.faces.model.DataModel.getRowData.

an object representing the data for the currently selected row index

Annotations
@Override
Exceptions
FacesException:
if an error occurs getting the row data
IllegalArgumentException:
if now row data is available at the currently specified row index
getRowIndexback to summary
public int getRowIndex()

Implements abstract jakarta.faces.model.DataModel.getRowIndex.

Doc from jakarta.faces.model.DataModel.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.

Returns:int

the index of the currently selected row

Annotations
@Override
Exceptions
FacesException:
if an error occurs getting the row index
getWrappedDataback to summary
public Object getWrappedData()

Implements abstract jakarta.faces.model.DataModel.getWrappedData.

Doc from jakarta.faces.model.DataModel.getWrappedData.

Return the object representing the data wrapped by this DataModel, if any.

Returns:Object

the Object that this model wraps.

Annotations
@Override
isRowAvailableback to summary
public boolean isRowAvailable()

Implements abstract jakarta.faces.model.DataModel.isRowAvailable.

Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list. Otherwise, return false.

Returns:boolean

Doc from jakarta.faces.model.DataModel.isRowAvailable.

true if and only if there is data available at the current index, false otherwise.

Annotations
@Override
Exceptions
FacesException:
if an error occurs getting the row availability
setRowIndexback to summary
public void setRowIndex(int rowIndex)

Implements abstract jakarta.faces.model.DataModel.setRowIndex.

Doc from jakarta.faces.model.DataModel.setRowIndex.

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 DataModelListeners.

Parameters
rowIndex:int

The new zero-relative index (must be non-negative)

Annotations
@Override
Exceptions
FacesException:
if an error occurs setting the row index
IllegalArgumentException:
if rowIndex is less than -1
setWrappedDataback to summary
public void setWrappedData(Object data)

Implements abstract jakarta.faces.model.DataModel.setWrappedData.

Set the wrapped data.

Parameters
data:Object

the wrapped data.

Annotations
@Override
Exceptions
ClassCastException:
if data is non-null and is not a Collection