Package jakarta.faces.model
Class CollectionDataModel<E>
- java.lang.Object
-
- jakarta.faces.model.DataModel<E>
-
- jakarta.faces.model.CollectionDataModel<E>
-
-
Constructor Summary
Constructors Constructor Description CollectionDataModel()
CollectionDataModel(Collection<E> collection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getRowCount()
Return the number of rows of data available.E
getRowData()
Return the object associated with the current row index.int
getRowIndex()
Get the current row index.Object
getWrappedData()
Get the entire collection of data associated with this component.boolean
isRowAvailable()
Returns true if a call to getRowData will return a valid object.void
setRowIndex(int rowIndex)
Set the current row index.void
setWrappedData(Object data)
Set the entire list of data associated with this component.-
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
-
CollectionDataModel
public CollectionDataModel()
-
CollectionDataModel
public CollectionDataModel(Collection<E> collection)
-
-
Method Detail
-
getRowCount
public int getRowCount()
Description copied from class:DataModel
Return the number of rows of data available.
If the number of rows of data available is not known then -1 is returned. This may happen for DataModels that wrap sources of data such as java.sql.ResultSet that provide an iterator to access the "next item" rather than a fixed-size collection of data.
- Specified by:
getRowCount
in classDataModel<E>
- Returns:
- the number of rows available.
-
getRowData
public E getRowData()
Description copied from class:DataModel
Return the object associated with the current row index.Method isRowAvailable may be called before attempting to access this method, to ensure that the data is available.
- Specified by:
getRowData
in classDataModel<E>
- Returns:
- The object associated with the current row index.
-
getRowIndex
public int getRowIndex()
Description copied from class:DataModel
Get the current row index.- Specified by:
getRowIndex
in classDataModel<E>
- Returns:
- The current row index.
-
getWrappedData
public Object getWrappedData()
Description copied from class:DataModel
Get the entire collection of data associated with this component. Note that the actual type of the returned object depends upon the concrete subclass of DataModel; the object will represent an "ordered sequence of components", but may be implemented as an array, java.util.List, java.sql.ResultSet or other similar types.- Specified by:
getWrappedData
in classDataModel<E>
- Returns:
- the wrapped object.
-
isRowAvailable
public boolean isRowAvailable()
Description copied from class:DataModel
Returns true if a call to getRowData will return a valid object.- Specified by:
isRowAvailable
in classDataModel<E>
- Returns:
- true if a call to getRowData will return a valid object. false otherwise.
-
setRowIndex
public void setRowIndex(int rowIndex)
Description copied from class:DataModel
Set the current row index. This affects the behaviour of the getRowData method in particular.- Specified by:
setRowIndex
in classDataModel<E>
- Parameters:
rowIndex
- The row index. It may be -1 to indicate "no row", or may be a value between 0 and getRowCount()-1.
-
setWrappedData
public void setWrappedData(Object data)
Description copied from class:DataModel
Set the entire list of data associated with this component. Note that the actual type of the provided object must match the expectations of the concrete subclass of DataModel. See getWrappedData.- Specified by:
setWrappedData
in classDataModel<E>
- Parameters:
data
- The object to be wrapped.
-
-