com.fujitsu.shun
クラス ShunPreparedRecordID

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

public class ShunPreparedRecordID

extends java.lang.Object

レコードIDによるXML文書の検索、XML文書の更新およびXML文書の削除をします。
レコードIDは、Java APIでShunsakuのXML文書を一意に識別する情報です。 レコードIDはShunResultSetクラスのgetRecordIDメソッドを使用して取得します。
ShunPreparedRecordIDオブジェクトは、 ShunConnectionクラスのprepareSearchRecordIDメソッド、prepareUpdateRecordIDメソッド、 またはprepareDeleteRecordIDメソッドで作成します。

関連項目:

ShunConnection.prepareSearchRecordID(), ShunConnection.prepareUpdateRecordID(), ShunConnection.prepareDeleteRecordID(), ShunResultSet.getRecordID(), ShunResultSet

メソッドの概要

void	add(java.lang.String recordID) 検索または削除対象のレコードIDをShunPreparedRecordIDオブジェクトに追加します。
void	add(java.lang.String recordID, java.io.InputStream updateData) 更新対象のレコードIDをStringで、 更新後の内容となるXML文書をUnicode(UTF-8)のInputStreamでShunPreparedRecordIDオブジェクトに追加します。
void	add(java.lang.String recordID, java.lang.String updateData) 更新対象のレコードIDおよび更新後の内容となるXML文書をStringでShunPreparedRecordIDオブジェクトに追加します。
void	close() ShunPreparedRecordIDオブジェクトを解放します。
int	deleteByRecordID() addメソッドで追加したレコードIDに対応するXML文書をすべて削除します。
boolean	exists(java.lang.String recordID) 指定したレコードIDが、addメソッドで追加されているかどうかを判定します。
int	getCount() addメソッドで追加したレコードIDの数を返却します。
ShunResultSet	searchByRecordID() addメソッドで追加したレコードIDに対応するデータを検索し、 検索した結果を格納するためのShunResultSetオブジェクトを作成します。
int	updateByRecordID() addメソッドで追加したレコードIDに対応するXML文書をすべて更新します。

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

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

メソッドの詳細

add

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

検索または削除対象のレコードIDをShunPreparedRecordIDオブジェクトに追加します。
指定されたレコードIDと同一のレコードIDがすでに追加されている場合は、上書きされます。
本メソッドは、 ShunConnectionクラスのprepareDeleteRecordIDメソッドまたはprepareSearchRecordIDメソッドで作成されたShunPreparedRecordIDオブジェクトで有効です。 他のShunPreparedRecordIDオブジェクトでは、例外が発生します。

パラメータ:

recordID - レコードID

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunResultSet.getRecordID(), ShunConnection.prepareDeleteRecordID(), ShunConnection.prepareSearchRecordID()

add

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

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

パラメータ:

recordID - レコードID

updateData - XML文書

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunResultSet.getRecordID(), ShunConnection.prepareUpdateRecordID()

add

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

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

パラメータ:

recordID - レコードID

updateData - XML文書

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunResultSet.getRecordID(), ShunConnection.prepareUpdateRecordID()

close

public void close()
           throws ShunException

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

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.close(), ShunResultSet.close()

deleteByRecordID

public int deleteByRecordID()
                     throws ShunException

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

戻り値:

0

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareDeleteRecordID()

exists

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

指定したレコードIDが、addメソッドで追加されているかどうかを判定します。

パラメータ:

recordID - レコードID

戻り値:

指定したレコードIDが存在する場合はtrue、存在しない場合はfalse

例外:

ShunException - Shunsaku Java APIの例外

getCount

public int getCount()
             throws ShunException

addメソッドで追加したレコードIDの数を返却します。

戻り値:

addメソッドで追加されたレコードIDの数

例外:

ShunException - Shunsaku Java APIの例外

searchByRecordID

public ShunResultSet searchByRecordID()
                               throws ShunException

addメソッドで追加したレコードIDに対応するデータを検索し、 検索した結果を格納するためのShunResultSetオブジェクトを作成します。
追加したレコードIDに対応するデータが削除などで存在しない場合、 ShunResultSetは、以下のように作成されます。
[指定したレコードIDのすべてが存在しない場合]

結果が0件(ヒット件数が0件)となります。

[指定したレコードIDの一部が存在しない場合]

依頼したレコードIDの数だけ結果が格納されます。存在しないレコードIDについては、データが空文字となります。

本メソッドは、 ShunConnectionクラスのprepareSearchRecordIDメソッドで作成されたShunPreparedRecordIDオブジェクトで有効です。 他のShunPreparedRecordIDオブジェクトでは、例外が発生します。
ShunPreparedRecordIDオブジェクトごとに1つのShunResultSetがいつでも作成できます。 したがって、すでに当オブジェクトから作成したShunResultSetオブジェクトが存在する場合、 本メソッドを実行したときにShunResultSetオブジェクトを解放して、 新たにShunResultSetオブジェクトを作成します。
ShunPreparedRecordIDオブジェクトに追加したレコードIDは、 本メソッドが終了したときに削除されます。

戻り値:

ShunResultSetオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

add(String), ShunConnection.prepareSearchRecordID()

updateByRecordID

public int updateByRecordID()
                     throws ShunException

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

戻り値:

0

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

add(String,String), add(String,InputStream), ShunConnection.prepareUpdateRecordID()