jakarta.faces.model

Class ResultDataModel

java.lang.Object

jakarta.faces.model.DataModel<SortedMap<String,Object>>

jakarta.faces.model.ResultDataModel

All Implemented Interfaces:

Iterable<SortedMap<String,Object>>

public class ResultDataModel
extends DataModel<SortedMap<String,Object>>

ResultDataModel is a convenience implementation of DataModel that wraps a JSTL Result object, typically representing the results of executing an SQL query via JSTL tags.

Constructor Summary

Constructors

Constructor and Description
ResultDataModel() Construct a new ResultDataModel with no specified wrapped data.
ResultDataModel(Result result) Construct a new ResultDataModel wrapping the specified Result.

Method Summary

Modifier and Type	Method and Description
int	getRowCount() If there is wrappedData available, return the length of the array returned by calling getRows() on the underlying Result.
SortedMap<String,Object>	getRowData() If row data is available, return the SortedMap array element at the index specified by rowIndex of the array returned by calling getRows() on the underlying Result.
int	getRowIndex() Return the zero-relative index of the currently selected row.
Object	getWrappedData() Return the object representing the data wrapped by this DataModel, if any.
boolean	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 length of the array returned by calling getRows() on the underlying Result.
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 this DataModel.

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

ResultDataModel

public ResultDataModel()

Construct a new ResultDataModel with no specified wrapped data.

ResultDataModel

public ResultDataModel(Result result)

Construct a new ResultDataModel wrapping the specified Result.

Parameters:

result - Result to be wrapped (if any)

Method Detail

isRowAvailable

public boolean 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 length of the array returned by calling getRows() on the underlying Result. Otherwise, return false.

Specified by:

isRowAvailable in class DataModel<SortedMap<String,Object>>

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 array returned by calling getRows() on the underlying Result. If no wrappedData is available, return -1.

Specified by:

getRowCount in class DataModel<SortedMap<String,Object>>

Returns:

the number of rows of data represented by this DataModel

Throws:

FacesException - if an error occurs getting the row count

getRowData

public SortedMap<String,Object> getRowData()

If row data is available, return the SortedMap array element at the index specified by rowIndex of the array returned by calling getRows() on the underlying Result. If no wrapped data is available, return null.

Note that, if a non-null Map is returned by this method, it will contain the values of the columns for the current row, keyed by column name. Column name comparisons must be performed in a case-insensitive manner.

Specified by:

getRowData in class DataModel<SortedMap<String,Object>>

Returns:

an object representing the data for the currently selected row index

Throws:

FacesException - if an error occurs getting the row data

IllegalArgumentException - 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 class DataModel<SortedMap<String,Object>>

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

Specified by:

setRowIndex in class DataModel<SortedMap<String,Object>>

Parameters:

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

Throws:

FacesException - if an error occurs setting the row index

IllegalArgumentException - if rowIndex is less than -1

getWrappedData

public Object getWrappedData()

Description copied from class: DataModel

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

Specified by:

getWrappedData in class DataModel<SortedMap<String,Object>>

Returns:

the Object that this model wraps.

setWrappedData

public void setWrappedData(Object data)

Description copied from class: DataModel

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.

Specified by:

setWrappedData in class DataModel<SortedMap<String,Object>>

Parameters:

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

Throws:

ClassCastException - if data is non-null and is not a Result