TabularData (Java Platform SE 7)

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

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, 2013, 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