public Class ScalarDataModel<E>

Construct a new ScalarDataModel with no specified wrapped data.

Construct a new ScalarDataModel wrapping the specified scalar object.

Parameters

scalar:E

Scalar to be wrapped (if any)

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

If there is wrappedData available, return 1. 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

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

If wrapped data is available, return the wrapped data instance. Otherwise, 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

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

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

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

Return true if there is wrappedData available, and the current value of rowIndex is zero. 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

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

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

Doc from jakarta.faces.model.DataModel.setWrappedData.

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 DataModelListeners indicating that this row is now selected.

Parameters

data:Object

Data collection to be wrapped, or null to detach from any previous data collection

Annotations

@Override

Exceptions

ClassCastException:

if data is not of the appropriate type for this DataModel implementation