- java.lang.Object
-
- javax.faces.model.DataModel<E>
-
- All Implemented Interfaces:
- Iterable<E>
- Direct Known Subclasses:
- ArrayDataModel, CollectionDataModel, ListDataModel, ResultDataModel, ResultSetDataModel, ScalarDataModel
public abstract class DataModel<E> extends Object implements Iterable<E>
DataModel is an abstraction around arbitrary data binding technologies that can be used to adapt a variety of data sources for use by JavaServer Faces components that support per-row processing for their child components (such as
UIData
.The data collection underlying a
DataModel
instance is modeled as a collection of row objects that can be accessed by a zero-relative cursor (row index). The APIs provide mechanisms to position to a specified zero-relative row index, and to retrieve an object that represents the data that corresponds to the current row index.A concrete
DataModel
instance is attached to a particular collection of underlying data by calling thesetWrappedData()
method. It can be detached from that underlying data collection by passing anull
parameter to this method.Concrete
DataModel
implementations must provide a public zero-arguments constructor that callssetWrappedData(null)
. A convenience constructor that takes a wrapped object of the appropriate type (and passes it on via a call tosetWrappedData()
, should also be provided.Event listeners may be registered to receive notifications of when a new row index is selected.
-
-
Constructor Summary
Constructors Constructor and Description DataModel()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description void
addDataModelListener(DataModelListener listener)
Add a newDataModelListener
to the set interested in notifications from thisDataModel
.DataModelListener[]
getDataModelListeners()
Return the set ofDataModelListener
s interested in notifications from thisDataModel
.abstract int
getRowCount()
Return the number of rows of data objects represented by thisDataModel
.abstract E
getRowData()
Return an object representing the data for the currenty selected row index.abstract int
getRowIndex()
Return the zero-relative index of the currently selected row.abstract Object
getWrappedData()
Return the object representing the data wrapped by thisDataModel
, if any.abstract boolean
isRowAvailable()
Return a flag indicating whether there isrowData
available at the currentrowIndex
.Iterator<E>
iterator()
Return a read-only
Iterator
over the row data for this model.void
removeDataModelListener(DataModelListener listener)
Remove an existingDataModelListener
from the set interested in notifications from thisDataModel
.abstract 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.abstract void
setWrappedData(Object data)
Set the object representing the data collection wrapped by thisDataModel
.-
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
-
-
-
-
Method Detail
-
isRowAvailable
public abstract boolean isRowAvailable()
Return a flag indicating whether there is
rowData
available at the currentrowIndex
. If nowrappedData
is available, returnfalse
.- Throws:
FacesException
- if an error occurs getting the row availability
-
getRowCount
public abstract int getRowCount()
Return the number of rows of data objects represented by this
DataModel
. If the number of rows is unknown, or nowrappedData
is available, return -1.- Throws:
FacesException
- if an error occurs getting the row count
-
getRowData
public abstract E getRowData()
Return an object representing the data for the currenty selected row index. If no
wrappedData
is available, returnnull
.- Throws:
FacesException
- if an error occurs getting the row dataIllegalArgumentException
- if now row data is available at the currently specified row index
-
getRowIndex
public abstract int getRowIndex()
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.- Throws:
FacesException
- if an error occurs getting the row index
-
setRowIndex
public abstract 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. 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.- 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
public abstract Object getWrappedData()
Return the object representing the data wrapped by this
DataModel
, if any.
-
setWrappedData
public abstract void setWrappedData(Object data)
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.- Parameters:
data
- Data collection to be wrapped, ornull
to detach from any previous data collection- Throws:
ClassCastException
- ifdata
is not of the appropriate type for thisDataModel
implementation
-
addDataModelListener
public void addDataModelListener(DataModelListener listener)
Add a new
DataModelListener
to the set interested in notifications from thisDataModel
.- Parameters:
listener
- The newDataModelListener
to be registered- Throws:
NullPointerException
- iflistener
isnull
-
getDataModelListeners
public DataModelListener[] getDataModelListeners()
Return the set of
DataModelListener
s interested in notifications from thisDataModel
. If there are no such listeners, an empty array is returned.
-
removeDataModelListener
public void removeDataModelListener(DataModelListener listener)
Remove an existing
DataModelListener
from the set interested in notifications from thisDataModel
.- Parameters:
listener
- The oldDataModelListener
to be deregistered- Throws:
NullPointerException
- iflistener
isnull
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/model/DataModel.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.