TabularData (Java Platform SE 8)

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

TabularDataSupport
```
public interface TabularData
```
TabularDataインタフェースは、テーブル・データ構造を表現する特定の型の複合公開データオブジェクトの動作を指定します。

導入されたバージョン:

1.5

メソッドのサマリー

すべてのメソッドインスタンス・メソッド抽象メソッド
修飾子と型	メソッドと説明
`Object[]`	`calculateIndex(CompositeData value)` この`TabularData`インスタンスに、指定された複合データ`value`パラメータを参照するために使用されるインデックスが追加されている場合、このインデックスを計算します。
`void`	`clear()` この`TabularData`インスタンスからすべての`CompositeData`値(行)を削除します。
`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)` この`TabularData`インスタンスに`value`を追加します。
`void`	`putAll(CompositeData[] values)` `values`内のすべての要素をこの`TabularData`インスタンスに追加します。
`CompositeData`	`remove(Object[] key)` `key`をインデックスに持つ`CompositeData`値をこの`TabularData`インスタンスから削除し、その削除した値を返します。`key`をインデックスに持つ値が存在しない場合は`null`を返します。
`int`	`size()` この`TabularData`インスタンスに含まれる`CompositeData`値の数(行数)を返します。
`String`	`toString()` この`TabularData`インスタンスの文字列表現を返します。
`Collection<?>`	`values()` この`TabularData`インスタンスに含まれる`CompositeData`値(行)のコレクション・ビューを返します。

- メソッドの詳細
  - getTabularType
```
TabularType getTabularType()
```
    このTabularDataインスタンスを記述する表型を返します。
    
    戻り値:
    
    表型。
  - calculateIndex
```
Object[] calculateIndex(CompositeData value)
```
    このTabularDataインスタンスに、指定された複合データvalueパラメータを参照するために使用されるインデックスが追加されている場合、このインデックスを計算します。このメソッドは、指定された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)
```
    このTabularDataインスタンスにvalueを追加します。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)
```
    keyをインデックスに持つCompositeData値をこのTabularDataインスタンスから削除し、その削除した値を返します。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 - valueの要素がnullの場合
    
    InvalidOpenTypeException - valueの要素がこのTabularDataインスタンスの行の型定義に準拠していない場合。
    
    KeyAlreadyExistsException - このTabularDataインスタンスのTabularType定義に準拠するように計算されたvaluesの要素のインデックスが、このインスタンス内の既存の値にすでに一致している場合、またはvalues内に同じインデックスを持つ要素が2つ存在する場合。
  - clear
```
void clear()
```
    このTabularDataインスタンスからすべてのCompositeData値(行)を削除します。
  - 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インスタンスの文字列表現

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

インタフェースTabularData

メソッドのサマリー

メソッドの詳細

getTabularType

calculateIndex

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

equals

hashCode

toString