- 既知のすべての実装クラス:
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
指定されたobjパラメータとこのTabularData
インスタンスが等しいかどうかを比較します。このTabularData
インスタンスで、索引がkeyのCompositeData
値を返します。keyにマッピングする値がない場合は、null
を返します。この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
インスタンスに追加します。このTabularData
インスタンスから索引がkeyのCompositeData
値を削除し、削除された値を返します。または、索引がkeyの値がない場合はnull
を返します。int
size()
このTabularData
インスタンスに含まれるCompositeData
値(行数)の数を返します。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パラメータに対して適切に機能します。
-
hashCode
int hashCode()このTabularData
インスタンスのハッシュ・コード値を返します。TabularData
インスタンスのハッシュ・コードは、equals
の比較で使用されるすべての情報要素(表型と、すべての値マッピングのインデックスとして定義された内容)のハッシュ・コードの合計です。これにより、
Object.hashCode()
メソッドの一般規約によって要求される、任意の2つのTabularDataSupport
インスタンスt1
とt2
で、t1.equals(t2)
であればt1.hashCode()==t2.hashCode()
となることが保証されます。 -
toString
String toString()このTabularData
インスタンスの文字列表現を返します。文字列表現は、実装クラス名と、このインスタンスの表型で構成されます。
-