ResultDataModel (Java EE 5)

Java EE API

previous page next page
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.faces.model Class ResultDataModel

java.lang.Object
  extended by javax.faces.model.DataModel
      extended by javax.faces.model.ResultDataModel

public class ResultDataModel
extends DataModel

Extends: DataModel

ResultDataModel 是 DataModel 的便捷实现，它包装了一个 JSTL Result 对象，通常表示通过 JSTL 标记执行 SQL 查询的结果。

英文文档：

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
ResultDataModel()
          Construct a new ResultDataModel with no specified wrapped data.
ResultDataModel(javax.servlet.jsp.jstl.sql.Result result)
          Construct a new ResultDataModel wrapping the specified Result.
 
Method Summary
 int getRowCount()
          If there is wrappedData available, return the length of the array returned by calling getRows() on the underlying Result.
 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.
 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(Object data)
          Set the object representing the data collection wrapped by this DataModel.
 
Methods inherited from class javax.faces.model.DataModel
addDataModelListener, getDataModelListeners, removeDataModelListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

public ResultDataModel()

构造不带指定包装数据的新 ResultDataModel。

英文文档：

ResultDataModel

public ResultDataModel()

Construct a new ResultDataModel with no specified wrapped data.

public ResultDataModel(javax.servlet.jsp.jstl.sql.Result result)

构造包装指定 Result 的新 ResultDataModel。

result 要包装的 Result（如果有）
英文文档：

ResultDataModel

public ResultDataModel(javax.servlet.jsp.jstl.sql.Result result)

Construct a new ResultDataModel wrapping the specified Result.

Parameters:
result - Result to be wrapped (if any)

Method Detail

public boolean isRowAvailable()

如果有可用的 wrappedData，并且 rowIndex 的当前值大于等于 0，且小于对底层 Result 调用 getRows() 所返回的数组长度，则返回 true。否则返回 false。

ThrowsFacesException: 如果检测行可用性时发生错误
英文文档：

isRowAvailable

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.

Specified by:
isRowAvailable in class DataModel
Throws:
FacesException - if an error occurs getting the row availability

public int getRowCount()

如果有可用的 wrappedData，则返回对底层 Result 调用 getRows() 所返回的数组长度。如果没有任何可用的 wrappedData，则返回 -1。

ThrowsFacesException: 如果获取行数时发生错误
英文文档：

getRowCount

public 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.

Specified by:
getRowCount in class DataModel
Throws:
FacesException - if an error occurs getting the row count

public Object getRowData()

如果行数据可用，则返回一个 SortedMap 数组元素，该元素位于对底层 Result 调用 getRows() 所返回数组的 rowIndex 所指定的索引位置。如果没有任何包装数据可用，则返回 null。

注意，如果此方法返回非 null Map，那么它将包含当前行的列值，并且以列名称作为键。必须以大小写无关的方式执行列名称比较。

ThrowsFacesException: 如果获取行数据时发生错误
ThrowsIllegalArgumentException: 如果当前指定行索引处的行数据目前可用
英文文档：

getRowData

public 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.

Specified by:
getRowData in class DataModel
Throws:
FacesException - if an error occurs getting the row data
IllegalArgumentException - if now row data is available at the currently specified row index

public int getRowIndex()
ThrowsFacesException: NullPointerException 如果获取行索引时发生错误
英文文档：

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 class DataModel
Throws:
FacesException - if an error occurs getting the row index

public void setRowIndex(int rowIndex)
ThrowsFacesException: NullPointerException 如果设置行索引时发生错误
ThrowsIllegalArgumentException: NullPointerException 如果 rowIndex 小于 -1
英文文档：

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 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 DataModelListeners.

Specified by:
setRowIndex in class DataModel
Parameters:
rowIndex - The new zero-relative index (must be non-negative)
Throws:
FacesException - if an error occurs setting the row index
IllegalArgumentException - if rowIndex is less than -1

public Object getWrappedData()
英文文档：

getWrappedData

public Object getWrappedData()
Description copied from class: DataModel

Return the object representing the data wrapped by this DataModel, if any.

Specified by:
getWrappedData in class DataModel

public void setWrappedData(Object data)
ThrowsClassCastException: 如果 data 非 null，并且不是 Result
英文文档：

setWrappedData

public void setWrappedData(Object data)
Description copied from class: 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 DataModelListeners indicating that this row is now selected.

Specified by:
setWrappedData in class DataModel
Parameters:
data - Data collection to be wrapped, or null to detach from any previous data collection
Throws:
ClassCastException - if data is non-null and is not a Result
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.

一看就知道只有菜鸟才干这么无知的事啦。

PS : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正；若因此而造成任何损失请直接找人民主席，请勿与本人联系。谢谢！

previous page start next page