Class ResultDataModel
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
ConstructorDescriptionConstruct a newResultDataModel
with no specified wrapped data.ResultDataModel
(Result result) Construct a newResultDataModel
wrapping the specifiedResult
. -
Method Summary
Modifier and TypeMethodDescriptionint
If there iswrappedData
available, return the length of the array returned by callinggetRows()
on the underlyingResult
.If row data is available, return theSortedMap
array element at the index specified byrowIndex
of the array returned by callinggetRows()
on the underlyingResult
.int
Return the zero-relative index of the currently selected row.Return the object representing the data wrapped by thisDataModel
, if any.boolean
Returntrue
if there iswrappedData
available, and the current value ofrowIndex
is greater than or equal to zero, and less than the length of the array returned by callinggetRows()
on the underlyingResult
.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 javax.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 Details
-
ResultDataModel
public ResultDataModel()Construct a new
ResultDataModel
with no specified wrapped data. -
ResultDataModel
Construct a new
ResultDataModel
wrapping the specifiedResult
.- Parameters:
result
-Result
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 length of the array returned by callinggetRows()
on the underlyingResult
. Otherwise, returnfalse
.- Specified by:
isRowAvailable
in classDataModel<SortedMap<String,
Object>> - 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 callinggetRows()
on the underlyingResult
. If nowrappedData
is available, return -1.- Specified by:
getRowCount
in classDataModel<SortedMap<String,
Object>> - Throws:
FacesException
- if an error occurs getting the row count
-
getRowData
If row data is available, return the
SortedMap
array element at the index specified byrowIndex
of the array returned by callinggetRows()
on the underlyingResult
. If no wrapped data is available, returnnull
.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 classDataModel<SortedMap<String,
Object>> - 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<SortedMap<String,
Object>> - 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<SortedMap<String,
Object>> - 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<SortedMap<String,
Object>>
-
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<SortedMap<String,
Object>> - Parameters:
data
- Data collection to be wrapped, ornull
to detach from any previous data collection- Throws:
ClassCastException
- ifdata
is non-null
and is not aResult
-