com.fujitsu.shun
クラス ShunPreparedKey

java.lang.Object
  |
  +--com.fujitsu.shun.ShunPreparedKey

public class ShunPreparedKey

extends java.lang.Object

ダイレクトアクセスキーによるデータの検索、XML文書の更新およびXML文書の削除をします。
ShunPreparedKeyオブジェクトは、 ShunConnectionクラスのprepareSearchKeyメソッド、 prepareUpdateKeyメソッドまたはprepareDeleteKeyメソッドで作成します。

関連項目:

ShunConnection.prepareSearchKey(String,String), ShunConnection.prepareUpdateKey(String), ShunConnection.prepareDeleteKey(String)

フィールドの概要

static int

SHUN_KEY_COMPLETE_MATCH 完全に一致する比較方法を示します。

メソッドの概要

void	add(java.lang.String key) 検索または削除対象のダイレクトアクセスキーをShunPreparedKeyオブジェクトに追加します。
void	add(java.lang.String key, java.io.InputStream updateData) 更新対象のダイレクトアクセスキーをStringで、 更新後の内容となるXML文書をUnicode(UTF-8)のInputStreamでShunPreparedKeyオブジェクトに追加します。
void	add(java.lang.String key, java.lang.String updateData) 更新対象のダイレクトアクセスキーおよび更新後の内容となるXML文書をStringでShunPreparedKeyオブジェクトに追加します。
void	close() ShunPreparedKeyオブジェクトを解放します。
int	deleteByKey() addメソッドで追加したダイレクトアクセスキーに対応するXML文書をすべて削除します。
boolean	exists(java.lang.String key) 指定したダイレクトアクセスキーが、addメソッドで追加されているかどうかを判定します。
int	getCount() addメソッドで追加したダイレクトアクセスキーの数を返却します。
ShunResultSet	searchByKey() addメソッドで追加したダイレクトアクセスキーに対応するデータを検索し、 検索した結果を格納するための ShunResultSetオブジェクトを作成します。
void	setSearchType(int searchType) ダイレクトアクセスキーの比較方法を指定します。
int	updateByKey() addメソッドで追加したダイレクトアクセスキーに対応するXML文書をすべて更新します。

クラス java.lang.Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

SHUN_KEY_COMPLETE_MATCH

public static final int SHUN_KEY_COMPLETE_MATCH

完全に一致する比較方法を示します。

メソッドの詳細

add

public void add(java.lang.String key)
         throws ShunException

検索または削除対象のダイレクトアクセスキーをShunPreparedKeyオブジェクトに追加します。

指定されたダイレクトアクセスキーと同一のダイレクトアクセスキーがすでに追加されている場合は、 上書きされます。
本メソッドは、 ShunConnectionクラスのprepareDeleteKeyメソッドまたはprepareSearchKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。

パラメータ:

key - ダイレクトアクセスキー

ダイレクトアクセスキーは、1〜32768バイトの範囲で指定してください。
ダイレクトアクセスキーのサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、ShunConnectionクラスのgetServerEncodingメソッドで取得することができます。

例外:

ShunException - Shunsaku Java APIの例外

add

public void add(java.lang.String key,
                java.io.InputStream updateData)
         throws ShunException

更新対象のダイレクトアクセスキーをStringで、 更新後の内容となるXML文書をUnicode(UTF-8)のInputStreamでShunPreparedKeyオブジェクトに追加します。

指定されたダイレクトアクセスキーと同一のダイレクトアクセスキーがすでに追加されている場合は、 ダイレクトアクセスキーおよびXML文書は上書きされます。 InputStreamでXML文書を追加する場合、XML文書の文字コードはUnicode(UTF-8)でなければなりません。
本メソッドは、 ShunConnectionクラスのprepareUpdateKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。

パラメータ:

key - ダイレクトアクセスキー

ダイレクトアクセスキーは、1〜32768バイトの範囲で指定してください。
ダイレクトアクセスキーのサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、ShunConnectionクラスのgetServerEncodingメソッドで取得することができます。

updateData - XML文書

例外:

ShunException - Shunsaku Java APIの例外

add

public void add(java.lang.String key,
                java.lang.String updateData)
         throws ShunException

更新対象のダイレクトアクセスキーおよび更新後の内容となるXML文書をStringでShunPreparedKeyオブジェクトに追加します。
指定されたダイレクトアクセスキーと同一のダイレクトアクセスキーがすでに追加されている場合は、 ダイレクトアクセスキーおよびXML文書は上書きされます。
本メソッドは、 ShunConnectionクラスのprepareUpdateKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。

パラメータ:

key - ダイレクトアクセスキー

ダイレクトアクセスキーは、1〜32768バイトの範囲で指定してください。
ダイレクトアクセスキーのサイズは、 Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、 ShunConnectionクラスのgetServerEncodingメソッドで取得することができます。

updateData - XML文書

例外:

ShunException - Shunsaku Java APIの例外

close

public void close()
           throws ShunException

ShunPreparedKeyオブジェクトを解放します。
ShunPreparedKeyオブジェクトから作成したShunResultSetオブジェクトが存在すれば、 そのShunResultSetオブジェクトも解放されます。
ShunPreparedKeyオブジェクトは、 このオブジェクトを作成したShunConnectionオブジェクトが解放されるときに解放されます。

例外:

ShunException - Shunsaku Java APIの例外

deleteByKey

public int deleteByKey()
                throws ShunException

addメソッドで追加したダイレクトアクセスキーに対応するXML文書をすべて削除します。
本メソッドは、 ShunConnectionクラスのprepareDeleteKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。
ShunPreparedKeyオブジェクトに追加したダイレクトアクセスキーは、 本メソッドが終了したときに削除されます。

ダイレクトアクセスキーに対応したXML文書が複数存在した場合には、複数削除します。 削除済みのXML文書に対して、削除を実施した場合には正常終了となります。
本メソッドは、アプリケーションの多重実行が発生しない環境でご利用ください。

戻り値:

0

例外:

ShunException - Shunsaku Java APIの例外

exists

public boolean exists(java.lang.String key)
               throws ShunException

指定したダイレクトアクセスキーが、addメソッドで追加されているかどうかを判定します。

パラメータ:

key - ダイレクトアクセスキー

ダイレクトアクセスキーは、1〜32768バイトの範囲で指定してください。

戻り値:

指定したダイレクトアクセスキーが存在する場合はtrue、存在しない場合はfalse

例外:

ShunException - Shunsaku Java APIの例外

getCount

public int getCount()
             throws ShunException

addメソッドで追加したダイレクトアクセスキーの数を返却します。

戻り値:

addメソッドで追加されたダイレクトアクセスキーの数

例外:

ShunException - Shunsaku Java APIの例外

searchByKey

public ShunResultSet searchByKey()
                          throws ShunException

addメソッドで追加したダイレクトアクセスキーに対応するデータを検索し、 検索した結果を格納するための ShunResultSetオブジェクトを作成します。
本メソッドは、 ShunConnectionクラスのprepareSearchKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。
ShunPreparedKeyオブジェクトごとに1つのShunResultSetがいつでも作成できます。 したがって、すでに当オブジェクトから作成したShunResultSetオブジェクトが存在する場合、 本メソッドを実行したときにShunResultSetオブジェクトを解放して、 新たにShunResultSetオブジェクトを作成します。
ShunPreparedKeyオブジェクトに追加したダイレクトアクセスキーは、 本メソッドが終了したときに削除されます。
ダイレクトアクセスキーに対応したXML文書が複数存在した場合には、複数返却します。

戻り値:

ShunResultSetオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

setSearchType

public void setSearchType(int searchType)
                   throws ShunException

ダイレクトアクセスキーの比較方法を指定します。
本メソッドの呼出しが省略された場合、SHUN_KEY_COMPLETE_MATCHが指定されたとみなします。

パラメータ:

searchType - ダイレクトアクセスキーの比較方法

SHUN_KEY_COMPLETE_MATCHを指定してください。

例外:

ShunException - Shunsaku Java APIの例外

updateByKey

public int updateByKey()
                throws ShunException

addメソッドで追加したダイレクトアクセスキーに対応するXML文書をすべて更新します。
本メソッドは、 ShunConnectionクラスのprepareUpdateKeyメソッドで作成されたShunPreparedKeyオブジェクトで有効です。 他のShunPreparedKeyオブジェクトでは、例外が発生します。
ShunPreparedKeyオブジェクトに追加したダイレクトアクセスキーは、 本メソッドが終了したときに削除されます。
ダイレクトアクセスキーに対応したXML文書が複数存在した場合には、複数更新します。 削除済みのXML文書に対して、更新を実施した場合にはエラーとなります。
本メソッドは、アプリケーションの多重実行が発生しない環境でご利用ください。

戻り値:

0

例外:

ShunException - Shunsaku Java APIの例外