public class ResultDataModel extends DataModel<java.util.SortedMap<java.lang.String,java.lang.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 and Description |
---|
ResultDataModel()
Construct a new
ResultDataModel with no specified
wrapped data. |
ResultDataModel(Result result)
Construct a new
ResultDataModel wrapping the specified
Result . |
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 . |
java.util.SortedMap<java.lang.String,java.lang.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.
|
java.lang.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(java.lang.Object data)
Set the object representing the data collection wrapped by this
DataModel . |
addDataModelListener, getDataModelListeners, iterator, removeDataModelListener
public ResultDataModel()
Construct a new ResultDataModel
with no specified
wrapped data.
public ResultDataModel(Result result)
Construct a new ResultDataModel
wrapping the specified
Result
.
result
- Result
to be wrapped (if any)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
.
isRowAvailable
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
FacesException
- if an error occurs getting the row availabilitypublic 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.
getRowCount
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
DataModel
FacesException
- if an error occurs getting the row countpublic java.util.SortedMap<java.lang.String,java.lang.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.
getRowData
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
FacesException
- if an error occurs getting the row datajava.lang.IllegalArgumentException
- if now row data is available
at the currently specified row indexpublic int getRowIndex()
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.
getRowIndex
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
FacesException
- if an error occurs getting the row indexpublic void setRowIndex(int rowIndex)
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
DataModelListener
s.
setRowIndex
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
rowIndex
- The new zero-relative index (must be non-negative)FacesException
- if an error occurs setting the row indexjava.lang.IllegalArgumentException
- if rowIndex
is less than -1public java.lang.Object getWrappedData()
DataModel
Return the object representing the data wrapped by this
DataModel
, if any.
getWrappedData
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
Object
that this model wraps.public void setWrappedData(java.lang.Object data)
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
DataModelListener
s indicating that this row is now selected.
setWrappedData
in class DataModel<java.util.SortedMap<java.lang.String,java.lang.Object>>
data
- Data collection to be wrapped, or null
to
detach from any previous data collectionjava.lang.ClassCastException
- if data
is
non-null
and is not a Result