既知のすべての実装クラス:: TabularDataSupport

public interface TabularData

TabularDataインタフェースは、「表形式データ」構造を表す特定のタイプの複合「オープン・データ」オブジェクトの動作を指定します。

導入されたバージョン:: 1.5

メソッドのサマリー

修飾子と型

メソッド

説明

Object[]

calculateIndex(CompositeData value)

指定したコンポジット・データvalueパラメータ(このインスタンスに追加された場合)を参照するためにこのTabularDataインスタンスで使用される索引を計算します。

void

clear()

このTabularDataインスタンスからすべてのCompositeData値(ie行)を削除します。

boolean

containsKey(Object[] key)

このTabularDataインスタンスに、指定されたkeyの索引を持つCompositeData値(つまり、行)が含まれている場合のみ、trueを返します。

boolean

containsValue(CompositeData value)

このTabularDataインスタンスに指定したCompositeData値が含まれている場合のみ、trueを返します。

boolean

equals(Object obj)

指定されたobjパラメータとこのTabularDataインスタンスが等しいかどうかを比較します。

CompositeData

get(Object[] key)

このTabularDataインスタンスで、索引がkeyのCompositeData値を返します。keyにマッピングする値がない場合は、nullを返します。

TabularType

getTabularType()

このTabularDataインスタンスを記述する「表形式タイプ」を返します。

int

hashCode()

このTabularDataインスタンスのハッシュ・コード値を返します。

boolean

isEmpty()

このTabularDataインスタンスに含まれるCompositeData値(行数)の数がゼロの場合、trueを返します。

Set<?>

keySet()

このTabularDataインスタンスに含まれるCompositeData値(行)のキー(インデックス値)のセット・ビューを返します。

void

put(CompositeData value)

valueをこのTabularDataインスタンスに追加します。

void

putAll(CompositeData[] values)

valuesのすべての要素をこのTabularDataインスタンスに追加します。

CompositeData

remove(Object[] key)

このTabularDataインスタンスから索引がkeyのCompositeData値を削除し、削除された値を返します。または、索引がkeyの値がない場合はnullを返します。

int

size()

このTabularDataインスタンスに含まれるCompositeData値(行数)の数を返します。

String

toString()

このTabularDataインスタンスの文字列表現を返します。

Collection<?>

values()

このTabularDataインスタンスに含まれるCompositeData値(行)のコレクション・ビューを返します。

メソッドの詳細
- getTabularType
  
  TabularType getTabularType()
  
  このTabularDataインスタンスを記述する「表形式タイプ」を返します。
  
  戻り値:
  
  表型。
- calculateIndex
  
  Object[] calculateIndex(CompositeData value)
  
  指定したコンポジット・データvalueパラメータ(このインスタンスに追加された場合)を参照するためにこのTabularDataインスタンスで使用される索引を計算します。このメソッドは、指定されたvalueのタイプの有効性をチェックしますが、計算された索引がこのTabularDataインスタンスの値を参照するためにすでに使用されているかどうかはチェックしません。
  
  パラメータ:
  
  value - このTabularDataインスタンスの索引を計算するコンポジット・データ値。このインスタンスの行タイプと同じコンポジット・タイプである必要があります。nullにできません。
  
  戻り値:
  
  指定したvalueがこのTabularDataインスタンスにある索引。
  
  例外:
  
  NullPointerException - valueがnullの場合
  
  InvalidOpenTypeException - valueがこのTabularDataインスタンスの行タイプ定義に準拠していない場合。
- size
  
  int size()
  
  このTabularDataインスタンスに含まれるCompositeData値(行数)の数を返します。
  
  戻り値:
  
  含まれる値の数。
- isEmpty
  
  boolean isEmpty()
  
  このTabularDataインスタンスに含まれるCompositeData値(行数)の数がゼロの場合、trueを返します。
  
  戻り値:
  
  このTabularDataが空の場合、true。
- containsKey
  
  boolean containsKey(Object[] key)
  
  このTabularDataインスタンスに、指定されたkeyの索引を持つCompositeData値(つまり、行)が含まれている場合のみ、trueを返します。 keyがnullであるか、このTabularDataインスタンスのTabularType定義に準拠していない場合、このメソッドは単にfalseを返します。
  
  パラメータ:
  
  key - このTabularDataインスタンスに存在する索引値をテストします。
  
  戻り値:
  
  このTabularDataが、指定されたキーを持つ行値に索引付けする場合、true。
- containsValue
  
  boolean containsValue(CompositeData value)
  
  このTabularDataインスタンスに指定したCompositeData値が含まれている場合のみ、trueを返します。 valueがnullであるか、このTabularDataインスタンスの行タイプ定義に準拠していない場合、このメソッドは単にfalseを返します。
  
  パラメータ:
  
  value - このTabularDataインスタンスに存在する行値をテストします。
  
  戻り値:
  
  このTabularDataインスタンスに指定した行値が含まれている場合はtrue。
- get
  
  CompositeData get(Object[] key)
  
  このTabularDataインスタンスで、索引がkeyのCompositeData値を返します。keyにマッピングする値がない場合は、nullを返します。
  
  パラメータ:
  
  key - 返される行のキー。
  
  戻り値:
  
  keyに対応する値。
  
  例外:
  
  NullPointerException - keyがnullの場合
  
  InvalidKeyException - keyがこのTabularDataインスタンスの* TabularType定義に準拠していない場合
- put
  
  void put(CompositeData value)
  
  valueをこのTabularDataインスタンスに追加します。 valueのコンポジット・タイプは、このインスタンスの行タイプ(this.getTabularType().getRowType() によって返されるコンポジット・タイプ)と同じである必要があり、このTabularDataインスタンスには、索引が追加されるvalueに対して計算されたものと同じである既存の値が存在していない必要があります。 valueの索引は、このTabularDataインスタンスのTabularType定義(TabularType.getIndexNames() を参照してください)に従って計算されます。
  
  パラメータ:
  
  value - このTabularDataインスタンスに新規行として追加するコンポジット・データ値。このインスタンスの行タイプと同じコンポジット・タイプである必要があります。nullにできません。
  
  例外:
  
  NullPointerException - valueがnullの場合
  
  InvalidOpenTypeException - valueがこのTabularDataインスタンスの行タイプ定義に準拠していない場合。
  
  KeyAlreadyExistsException - このTabularDataインスタンスのTabularType定義に従って計算されたvalueの索引が、基礎となるHashMapの既存の値にすでにマップされている場合。
- remove
  
  CompositeData remove(Object[] key)
  
  このTabularDataインスタンスから索引がkeyのCompositeData値を削除し、削除された値を返します。または、索引がkeyの値がない場合はnullを返します。
  
  パラメータ:
  
  key - このTabularDataインスタンスで取得する値の索引。このTabularDataインスタンスの行タイプ定義で有効である必要があります。nullにできません。
  
  戻り値:
  
  指定されたキーに関連付けられている前の値、またはキーにマッピングがなかった場合はnull。
  
  例外:
  
  NullPointerException - keyがnullの場合
  
  InvalidKeyException - keyがこのTabularDataインスタンスのTabularType定義に準拠していない場合
- putAll
  
  void putAll(CompositeData[] values)
  
  valuesのすべての要素をこのTabularDataインスタンスに追加します。 values内のいずれかの要素がputで定義された制約を満たさない場合、またはvalues内の2つの要素に、このTabularDataインスタンスのTabularType定義に従って計算された同じ索引がある場合、失敗を説明する例外がスローされ、valuesの要素が追加されないため、このTabularDataインスタンスは変更されません。
  
  パラメータ:
  
  values - このTabularDataインスタンスに新規行として追加されるコンポジット・データ値の配列。valuesがnullまたは空の場合、このメソッドは何もせずに返します。
  
  例外:
  
  NullPointerException - valuesの要素がnullの場合
  
  InvalidOpenTypeException - valuesの要素がこのTabularDataインスタンスの行タイプ定義に準拠していない場合
  
  KeyAlreadyExistsException - このTabularDataインスタンスのTabularType定義に従って計算されたvaluesの要素の索引が、このインスタンスの既存の値にすでにマップされている場合、またはvaluesの2つの要素が同じ索引を持つ場合。
- clear
  
  void clear()
  
  このTabularDataインスタンスからすべてのCompositeData値(ie行)を削除します。
- keySet
  
  Set<?> keySet()
  
  このTabularDataインスタンスに含まれるCompositeData値(行)のキー(インデックス値)のセット・ビューを返します。返されるSetはSet<List<?>>ですが、互換性を維持するためにSet<?>として宣言されます。返されるセットを使って、キーの繰返し処理を行うことができます。
  
  戻り値:
  
  このTabularDataインスタンスで使用されるインデックス値のセット・ビュー(Set<List<?>>)。
- values
  
  Collection<?> values()
  
  このTabularDataインスタンスに含まれるCompositeData値(行)のコレクション・ビューを返します。返されるCollectionはCollection<CompositeData>ですが、互換性を維持するためにCollection<?>として宣言されます。返されるコレクションを使って、値の繰返し処理を行うことができます。
  
  戻り値:
  
  このTabularDataインスタンスに格納されている行のコレクション・ビュー(Collection<CompositeData>)。
- equals
  boolean equals(Object obj)
  
  指定されたobjパラメータとこのTabularDataインスタンスが等しいかどうかを比較します。
  次のすべての条件が満たされている場合に限り、trueを返します。
  
  objがnullでない
  
  objがTabularDataインタフェースも実装している
  
  行型が等しい
  
  内容(インデックスと値のマッピング)が等しい
  
  これにより、このequalsメソッドは、TabularDataインタフェースの異なる実装であるobjパラメータに対して適切に機能します。
  
  オーバーライド:
  
  equals、クラスObject
  
  パラメータ:
  
  obj - このTabularDataインスタンスと等しいかどうかを比較するオブジェクト。
  
  戻り値:
  
  指定されたオブジェクトがこのTabularDataインスタンスと等しい場合はtrue。
  
  関連項目:
  
  Object.hashCode()
  
  HashMap
- hashCode
  int hashCode()
  
  このTabularDataインスタンスのハッシュ・コード値を返します。
  TabularDataインスタンスのハッシュ・コードは、equalsの比較で使用されるすべての情報要素(表型と、すべての値マッピングのインデックスとして定義された内容)のハッシュ・コードの合計です。
  これにより、Object.hashCode()メソッドの一般規約によって要求される、任意の2つのTabularDataSupportインスタンスt1とt2で、t1.equals(t2)であればt1.hashCode()==t2.hashCode()となることが保証されます。
  
  オーバーライド:
  
  hashCode、クラスObject
  
  戻り値:
  
  このTabularDataSupportインスタンスのハッシュ・コード値
  
  関連項目:
  
  Object.equals(java.lang.Object)
  
  System.identityHashCode(java.lang.Object)
- toString
  
  String toString()
  
  このTabularDataインスタンスの文字列表現を返します。
  文字列表現は、実装クラス名と、このインスタンスの表型で構成されます。
  
  オーバーライド:
  
  toString、クラスObject
  
  戻り値:
  
  このTabularDataインスタンスの文字列表現

インタフェースTabularData

メソッドのサマリー

メソッドの詳細

getTabularType

calculateIndex

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

equals

hashCode

toString