Hitachi

インメモリデータグリッド uCosminexus Elastic Application Data store ユーザーズガイド


20.2.7 Groupインタフェース

〈この項の構成〉

(1) 説明

ユーザファンクションを実行中のEADsサーバに属する,グループを操作するためのインタフェースです。

指定したグループに属さないkeyは操作できません。

(2) インタフェース名

com.hitachi.software.xeads.func.store.Group

(3) メソッド一覧

Groupインタフェースが提供するメソッド一覧を次の表に示します。

メソッド名

説明

toString()

グループ名を取得します。

keyIterator()

指定したグループに属するkeyに,ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は,グループの先頭のkeyとなります。

descendingKeyIterator()

指定したグループに属するkeyに,ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は,グループの末尾のkeyとなります。

higherKeyIterator()

指定したグループに属するkeyに,ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は,ASCIIコードの昇順で,指定されたkeyの次に位置するkeyとなります。

lowerDescendingKeyIterator()

指定したグループに属するkeyに,ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は,ASCIIコードの降順で,指定されたkeyの次に位置するkeyとなります。

put()(文字列指定)

valueをkeyに関連づけて格納します。

put()(Keyインタフェース指定)

valueをkeyに関連づけて格納します。

create()

新規にkeyを格納する場合だけ,valueをkeyに関連づけて格納します。

update()(文字列指定)

指定したkeyがすでに格納されている場合だけ,valueをkeyに関連づけて格納します(valueを更新します)。

update()(Keyインタフェース指定)

指定したkeyがすでに格納されている場合だけ,valueをkeyに関連づけて格納します(valueを更新します)。

replace()(文字列指定)

指定したkeyに関連づけられているvalueを,条件として指定したvalue(comparativeValue)と比較します。valueが一致している場合だけ,valueをkeyに関連づけて格納します(valueを置換します)。

replace()(Keyインタフェース指定)

指定したkeyに関連づけられているvalueを,条件として指定したvalue(comparativeValue)と比較します。valueが一致している場合だけ,valueをkeyに関連づけて格納します(valueを置換します)。

get()(文字列指定)

指定したkeyに関連づけられたvalueを取得します。

get()(Keyインタフェース指定)

指定したkeyに関連づけられたvalueを取得します。

remove()(文字列指定)

指定したkey,およびkeyに関連づけられたvalueを削除します。

remove()(Keyインタフェース指定)

指定したkey,およびkeyに関連づけられたvalueを削除します。

getLastUpdateTime()(文字列指定)

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

getLastUpdateTime()(Keyインタフェース指定)

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

getGroupNameSet()

グループ名の一覧をASCIIコードの昇順で取得します。

getValueUsageSize()(文字列指定)

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

getValueUsageSize()(Keyインタフェース指定)

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

getValueUsageSize()

下位のグループも含めて,グループに属する全valueのメモリ使用量の合計を取得します。

(4) toString()

(a) 機能

グループ名を取得します。

(b) 形式

public String toString()

(c) 戻り値

グループ名が返却されます。

(5) keyIterator()

(a) 機能

指定したグループに属するkeyに,ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は,グループの先頭のkeyとなります。

(b) 形式

public java.util.Iterator<Key> keyIterator() 
                                    throws EADsStoreException

(c) 戻り値

グループに属するkeyに,ASCIIコードの昇順でアクセスする反復子が返却されます。

(d) 発生する例外

  • EADsStoreException(予期しないエラー)

(e) 注意事項

  • タイミングによっては,反復子で取得したkeyに関連づけられたvalueが,削除されている場合があります。

  • keyはUTF-8でエンコーディングしたバイト配列でソートされます。

(6) descendingKeyIterator()

(a) 機能

指定したグループに属するkeyに,ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は,グループの末尾のkeyとなります。

(b) 形式

public java.util.Iterator<Key> descendingKeyIterator()
                                              throws EADsStoreException

(c) 戻り値

グループに属するkeyに,ASCIIコードの降順でアクセスする反復子が返却されます。

(d) 発生する例外

  • EADsStoreException(予期しないエラー)

(e) 注意事項

  • タイミングによっては,反復子で取得したkeyに関連づけられたvalueが,削除されている場合があります。

  • keyはUTF-8でエンコーディングしたバイト配列でソートされます。

(7) higherKeyIterator()

(a) 機能

指定したグループに属するkeyに,ASCIIコードの昇順でアクセスする反復子を取得します。

反復子の開始位置は,ASCIIコードの昇順で,指定されたkeyの次に位置するkeyとなります。

(b) 形式

public java.util.Iterator<Key> higherKeyIterator(java.lang.String key)
                                          throws EADsStoreException

(c) パラメータ

key

keyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 戻り値

グループに属するkeyに,ASCIIコードの昇順でアクセスする反復子が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • EADsStoreException(予期しないエラー)

(f) 注意事項

  • タイミングによっては,反復子で取得したkeyに関連づけられたvalueが,削除されている場合があります。

  • keyはUTF-8でエンコーディングしたバイト配列でソートされます。

(8) lowerDescendingKeyIterator()

(a) 機能

指定したグループに属するkeyに,ASCIIコードの降順でアクセスする反復子を取得します。

反復子の開始位置は,ASCIIコードの降順で,指定されたkeyの次に位置するkeyとなります。

(b) 形式

public java.util.Iterator<Key> lowerDescendingKeyIterator(java.lang.String key)
                                         throws EADsStoreException

(c) パラメータ

key

keyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 戻り値

グループに属するkeyに,ASCIIコードの降順でアクセスする反復子が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • EADsStoreException(予期しないエラー)

(f) 注意事項

  • タイミングによっては,反復子で取得したkeyに関連づけられたvalueが,削除されている場合があります。

  • keyはUTF-8でエンコーディングしたバイト配列でソートされます。

(9) put()(文字列指定)

(a) 機能

valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void put(java.lang.String key,
                java.lang.Object value)
         throws EADsStoreException

(c) パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(10) put()(Keyインタフェース指定)

(a) 機能

valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void put(Key key,
                java.lang.Object value)
         throws EADsStoreException

(c) パラメータ

key

valueに関連づけるKeyインタフェースのkeyを指定します。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(11) create()

(a) 機能

新規にkeyを格納する場合だけ,valueをkeyに関連づけて格納します。

valueの格納で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void create(java.lang.String key,
                   java.lang.Object value)
            throws EADsStoreException

(c) パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(12) update()(文字列指定)

(a) 機能

指定したkeyがすでに格納されている場合だけ,valueをkeyに関連づけて格納します(valueを更新します)。

valueの格納で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void update(java.lang.String key,
                   java.lang.Object value)
            throws EADsStoreException

(c) パラメータ

key

valueに関連づけるkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(13) update()(Keyインタフェース指定)

(a) 機能

指定したkeyがすでに格納されている場合だけ,valueをkeyに関連づけて格納します(valueを更新します)。

valueの格納で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void update(Key key,
                   java.lang.Object value)
            throws EADsStoreException

(c) パラメータ

key

valueに関連づけるKeyインタフェースのkeyを指定します。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(14) replace()(文字列指定)

(a) 機能

指定したkeyに関連づけられているvalueを,条件として指定したvalue(comparativeValue)と比較します。valueが一致している場合だけ,valueをkeyに関連づけて格納します(valueを置換します)。

valueの置き換えで問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void replace(java.lang.String key,
                    java.lang.Object value,
                    java.lang.Object comparativeValue)
             throws EADsStoreException

(c) パラメータ

key

置き換えるvalueに関連づけられたkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

comparativeValue

比較するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(15) replace()(Keyインタフェース指定)

(a) 機能

指定したkeyに関連づけられているvalueを,条件として指定したvalue(comparativeValue)と比較します。valueが一致している場合だけ,valueをkeyに関連づけて格納します(valueを置換します)。

valueの置き換えで問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void replace(Key key,
                    java.lang.Object value,
                    java.lang.Object comparativeValue)
             throws EADsStoreException

(c) パラメータ

key

置き換えるvalueに関連づけられたKeyインタフェースのkeyを指定します。

value

格納するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

comparativeValue

比較するvalueを指定します。

指定できるデータについては,「15.2.2(2) valueとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(16) get()(文字列指定)

(a) 機能

指定したkeyに関連づけられたvalueを取得します。

valueの取得で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public java.lang.Object get(java.lang.String key)
                     throws EADsStoreException

(c) パラメータ

key

取得するvalueに関連づけられたkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 戻り値

keyに関連づけられたvalueが返却されます。

指定したkeyに何も関連づけられていなかった場合は,nullが返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(17) get()(Keyインタフェース指定)

(a) 機能

指定したkeyに関連づけられたvalueを取得します。

valueの取得で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public java.lang.Object get(Key key)
                     throws EADsStoreException

(c) パラメータ

key

取得するvalueに関連づけられたKeyインタフェースのkeyを指定します。

(d) 戻り値

keyに関連づけられたvalueが返却されます。

指定したkeyに何も関連づけられていなかった場合は,nullが返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(18) remove()(文字列指定)

(a) 機能

指定したkey,およびkeyに関連づけられたvalueを削除します。

valueの削除で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void remove(java.lang.String key)
            throws EADsStoreException

(c) パラメータ

key

削除するvalueに関連づけられたkeyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(19) remove()(Keyインタフェース指定)

(a) 機能

指定したkey,およびkeyに関連づけられたvalueを削除します。

valueの削除で問題が発生した場合は,EADsStoreExceptionが返却されます。

(b) 形式

public void remove(Key key)
            throws EADsStoreException

(c) パラメータ

key

削除するvalueに関連づけられたKeyインタフェースのkeyを指定します。

(d) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(20) getLastUpdateTime()(文字列指定)

(a) 機能

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

(b) 形式

public long getLastUpdateTime(String key)
                       throws EADsStoreException

(c) パラメータ

key

keyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 戻り値

データの最終更新時刻(1970年1月1日00:00:00からの通算ミリ秒)が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(21) getLastUpdateTime()(Keyインタフェース指定)

(a) 機能

指定したkeyに関連づけられたvalueの最終更新時刻を取得します。

(b) 形式

public long getLastUpdateTime(Key key)
                       throws EADsStoreException

(c) パラメータ

key

valueに関連づけられたKeyインタフェースのkeyを指定します。

(d) 戻り値

データの最終更新時刻(1970年1月1日00:00:00からの通算ミリ秒)が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(22) getGroupNameSet()

(a) 機能

グループ名の一覧をASCIIコードの昇順で取得します。

(b) 形式

public Set<String> getGroupNameSet()
                            throws EADsStoreException

(c) 戻り値

直下の階層のグループ名の一覧(ASCIIコードの昇順)が返却されます。

(d) 発生する例外

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(23) getValueUsageSize()(文字列指定)

(a) 機能

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

(b) 形式

public long getValueUsageSize(String key)
                       throws EADsStoreException

(c) パラメータ

key

keyを指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」を参照してください。

(d) 戻り値

指定したkeyに関連づけられたvalueのメモリ使用量(単位:バイト)が返却されます。

valueをメモリに格納しないキャッシュの場合は,0が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(24) getValueUsageSize()(Keyインタフェース指定)

(a) 機能

指定したkeyに関連づけられたvalueのメモリ使用量を取得します。

(b) 形式

public long getValueUsageSize(Key key)
                       throws EADsStoreException

(c) パラメータ

key

valueに関連づけられたKeyインタフェースのkeyを指定します。

(d) 戻り値

指定したkeyに関連づけられたvalueのメモリ使用量(単位:バイト)が返却されます。

valueをメモリに格納しないキャッシュの場合は,0が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(25) getValueUsageSize()

(a) 機能

下位のグループも含めて,グループに属する全valueのメモリ使用量の合計を取得します。

(b) 形式

public long getValueUsageSize()
                       throws EADsStoreException

(c) 戻り値

グループに属する全valueのメモリ使用量(単位:バイト)の合計が返却されます。

valueをメモリに格納しないキャッシュの場合は,0が返却されます。

(d) 発生する例外

  • InternalServerException(EADsサーバの内部エラー)

  • EADsStoreException(予期しないエラー)