| java.lang.Object
 javax.faces.model.DataModel
All known Subclasses: javax.faces.model.ResultDataModel, javax.faces.model.ResultSetDataModel, javax.faces.model.ArrayDataModel, javax.faces.model.ListDataModel, javax.faces.model.ScalarDataModel,
| DataModel | | abstract public class DataModel (Code) | | Represents the data presented by a UIData component, together with
some state information about the currently selected row within the
datalist for use by listeners on UIData components. This class allows
managed bean code to avoid binding directly to UIData components for
typical uses.
Note that DataModel and its standard subclasses are not serializable,
as there is no state in a DataModel object itself that needs to be
preserved between render and restore-view. UIData components therefore
do not store their DataModel when serialized; they just evaluate their
"value" EL expression to refetch the object during the
apply-request-values phase.
Because DataModel is not serializable, any managed bean that needs to
be serialized and which has a member of type DataModel should therefore
mark that member transient. If there is a need to preserve the datalist
contained within the DataModel then ensure a reference to that list is
stored in a non-transient member, or use a custom serialization method
that explicitly serializes dataModel.getWrappedData.
See Javadoc of JSF Specification for more.
author:
Thomas Spiegl (latest modification by $Author: mbr $)
version:
$Revision: 512227 $ $Date: 2007-02-27 13:25:16 +0100 (Di, 27 Feb 2007) $ |
| getRowCount | | abstract public int getRowCount()(Code) | | 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.
|
| getRowData | | abstract public Object getRowData()(Code) | | 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.
throws:
RuntimeException - subclass of some kind if the current row indexis not within the range of the current wrappedData property. |
| getRowIndex | | abstract public int getRowIndex()(Code) | | Get the current row index.
|
| getWrappedData | | abstract public Object getWrappedData()(Code) | | 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.
|
| isRowAvailable | | abstract public boolean isRowAvailable()(Code) | | Returns true if a call to getRowData will return a valid object.
|
| setRowIndex | | abstract public void setRowIndex(int rowIndex)(Code) | | Set the current row index. This affects the behaviour of the
getRowData method in particular.
Parameter rowIndex may be -1 to indicate "no row", or may be a value
between 0 and getRowCount()-1.
|
| setWrappedData | | abstract public void setWrappedData(Object data)(Code) | | 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.
|
|
|