パッケージ jakarta.faces.model

クラス CollectionDataModel<E>

java.lang.ObjectSE
jakarta.faces.model.DataModel<E>
jakarta.faces.model.CollectionDataModel<E>
実装されているすべてのインターフェース:
IterableSE<E>
public class CollectionDataModel<E> extends DataModel<E>

CollectionDataModel は、Java オブジェクトの Collection をラップする DataModel の便利な実装です。

  • コンストラクターの詳細

    • CollectionDataModel

      public CollectionDataModel()

      ラップされたデータを指定せずに新しい CollectionDataModel を構築します。

    • CollectionDataModel

      public CollectionDataModel(CollectionSE<E> collection)

      指定されたリストをラップする新しい CollectionDataModel を構築します。

      パラメーター:
      collection - 包むコレクション。

  • メソッドの詳細

    • isRowAvailable

      public boolean isRowAvailable()

      使用可能な wrappedData があり、rowIndex の現在の値がゼロ以上で、リストのサイズより小さい場合は、true を返します。それ以外の場合は、false を返します。

      次で指定:
      クラス DataModel<E> の isRowAvailable 
      戻り値:
      現在のインデックスで利用可能なデータがある場合にのみ true、それ以外の場合は false。
      例外:
      FacesException - 行の可用性を取得するときにエラーが発生した場合

    • getRowCount

      public int getRowCount()

      利用可能な wrappedData がある場合は、リストの長さを返します。wrappedData が使用できない場合は、-1 を返します。

      次で指定:
      クラス DataModel<E> の getRowCount 
      戻り値:
      この DataModel によって表されるデータの行数
      例外:
      FacesException - 行数の取得中にエラーが発生した場合

    • getRowData

      public E getRowData()

      行データが利用可能な場合、rowIndex で指定されたインデックスの配列要素を返します。ラップされたデータが利用できない場合は、null を返します。

      次で指定:
      クラス DataModel<E> の getRowData 
      戻り値:
      現在選択されている行インデックスのデータを表すオブジェクト
      例外:
      FacesException - 行データの取得中にエラーが発生した場合
      IllegalArgumentExceptionSE - 現在指定されている行インデックスで行データが利用できる場合

    • getRowIndex

      public int getRowIndex()
      クラスからコピーされた説明: DataModel

      現在選択されている行のゼロ相対インデックスを返します。現在行に配置されていない場合、または使用可能な wrappedData がない場合は、-1 を返します。

      次で指定:
      クラス DataModel<E> の getRowIndex 
      戻り値:
      現在選択されている行のインデックス
      例外:
      FacesException - 行インデックスの取得中にエラーが発生した場合

    • setRowIndex

      public void setRowIndex(int rowIndex)
      クラスからコピーされた説明: DataModel

      現在選択されている行のゼロ相対インデックスを設定するか、行に配置されていないことを示すには -1 を設定します。基になるデータコレクションに行データが含まれていない値に行インデックスを設定することができます。呼び出し元は isRowAvailable() メソッドを使用して、行データが getRowData() メソッドで使用できるかどうかを検出できます。

      このメソッドが呼び出されたときに使用可能な wrappedData がない場合、指定された rowIndex が格納されます（その後の getRowData() の呼び出しで取得できます）が、イベントは送信されません。それ以外の場合、現在選択されている行インデックスがこの呼び出しによって変更されると、DataModelEvent がすべての登録済み DataModelListener の rowSelected() メソッドに送信されます。

      次で指定:
      クラス DataModel<E> の setRowIndex 
      パラメーター:
      rowIndex - 新しいゼロ相対インデックス (負でない必要があります)
      例外:
      FacesException - 行インデックスの設定中にエラーが発生した場合
      IllegalArgumentExceptionSE - rowIndex が -1 より小さい場合

    • getWrappedData

      public ObjectSE getWrappedData()
      クラスからコピーされた説明: DataModel

      この DataModel によってラップされたデータを表すオブジェクトがあれば、それを返します。

      次で指定:
      クラス DataModel<E> の getWrappedData 
      戻り値:
      このモデルがラップする Object 

    • setWrappedData

      public void setWrappedData(ObjectSE data)
      ラップされたデータを設定します。
      次で指定:
      クラス DataModel<E> の setWrappedData 
      パラメーター:
      data - ラップされたデータ。
      例外:
      ClassCastExceptionSE - data が null でなく、Collection でない場合