com.fujitsu.shun
クラス ShunPreparedStatement

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

public class ShunPreparedStatement

extends java.lang.Object

検索式によるデータの検索、およびXML文書の追加をします。
また、ソート式によるデータのソートおよびデータの集計をします。
ShunPreparedStatementオブジェクトは、 ShunConnectionクラスのprepareSearchメソッドまたはprepareInsertメソッドで作成します。

関連項目:

ShunConnection.prepareSearch(String,String), ShunConnection.prepareInsert(), ShunResultSet

フィールドの概要

static int	SHUN_DIRECTION_BACKWARD_EXCLUSIVE 取り出したいデータの取得終了位置を指定し、直前のデータを取り出すことを示します。
static int	SHUN_DIRECTION_FORWARD_EXCLUSIVE 取り出したいデータの取得開始位置を指定し、次のデータを取り出すことを示します。
static int	SHUN_NOT_SET_HIT_COUNT_LIMIT ヒット件数の上限値を設定していないことを示します。
static int	SHUN_RESET_HIT_COUNT_LIMIT ヒット件数の上限値の設定無効を示します。

メソッドの概要

void	add(java.io.InputStream data) XML文書を、 ShunPreparedStatementオブジェクトにUnicode(UTF-8)のInputStreamで追加します。
void	add(java.lang.String data) XML文書を、ShunPreparedStatementオブジェクトにStringで追加します。
void	close() ShunPreparedStatementオブジェクトを解放します。
int	executeInsert() addメソッドで設定したXML文書を、Shunsakuに追加します。
ShunResultSet	executeSearch() データの検索や集計を実行し、 実行した結果を格納するためのShunResultSetオブジェクトを作成します。
int	getHitCountLimit() ソート／集計時のヒット件数の上限値を返却します。
void	setHitCountLimit(int limit) ソート／集計実行時にヒット件数の上限値を指定します。
void	setRequest(int position, int requestCount) 検索式に一致したデータの何件目から返信するか、 および返信されるデータの最大件数を何件にするかを指定します。
void	setRequest(java.lang.String dataPosition, int requestCount, int direction) 取り出したデータの次のデータか直前のデータを取り出すために、 取り出したいデータの取得開始位置または取得終了位置を指定します。
void	setSort(java.lang.String sortExpression) ソート式を指定します。

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

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

フィールドの詳細

SHUN_DIRECTION_BACKWARD_EXCLUSIVE

public static final int SHUN_DIRECTION_BACKWARD_EXCLUSIVE

取り出したいデータの取得終了位置を指定し、直前のデータを取り出すことを示します。

関連項目:

setRequest(String,int,int), ShunResultSet.getFirstPosition()

SHUN_DIRECTION_FORWARD_EXCLUSIVE

public static final int SHUN_DIRECTION_FORWARD_EXCLUSIVE

取り出したいデータの取得開始位置を指定し、次のデータを取り出すことを示します。

関連項目:

setRequest(String,int,int), ShunResultSet.getLastPosition()

SHUN_NOT_SET_HIT_COUNT_LIMIT

public static final int SHUN_NOT_SET_HIT_COUNT_LIMIT

ヒット件数の上限値を設定していないことを示します。

関連項目:

setHitCountLimit(int)

SHUN_RESET_HIT_COUNT_LIMIT

public static final int SHUN_RESET_HIT_COUNT_LIMIT

ヒット件数の上限値の設定無効を示します。

関連項目:

setHitCountLimit(int)

メソッドの詳細

add

public void add(java.io.InputStream data)
         throws ShunException

XML文書を、 ShunPreparedStatementオブジェクトにUnicode(UTF-8)のInputStreamで追加します。
InputStreamでXML文書を追加する場合、 XML文書の文字コードはUnicode(UTF-8)でなければなりません。
本メソッドは、 ShunConnectionクラスのprepareInsertメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。

パラメータ:

data - XML文書

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareInsert()

add

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

XML文書を、ShunPreparedStatementオブジェクトにStringで追加します。
本メソッドは、 ShunConnectionクラスのprepareInsertメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。

パラメータ:

data - XML文書

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareInsert()

close

public void close()
           throws ShunException

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

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.close(), ShunResultSet.close()

executeInsert

public int executeInsert()
                  throws ShunException

addメソッドで設定したXML文書を、Shunsakuに追加します。
本メソッドは、 ShunConnectionクラスのprepareInsertメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。
ShunPreparedStatementオブジェクトに追加されたXML文書は、 本メソッドが終了したときに削除されます。

戻り値:

0

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

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

executeSearch

public ShunResultSet executeSearch()
                            throws ShunException

データの検索や集計を実行し、 実行した結果を格納するためのShunResultSetオブジェクトを作成します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。
ShunPreparedStatementオブジェクトごとに1つのShunResultSetがいつでも作成できます。 したがって、すでに当オブジェクトから作成したShunResultSetオブジェクトが存在する場合、 本メソッドを実行したときにShunResultSetオブジェクトを解放して、 新たにShunResultSetオブジェクトを作成します。
setRequestメソッドの呼出しが省略された場合、 返信されるデータの最大件数の値はconductor用動作環境ファイルのAnsMaxで設定した値になります。

戻り値:

ShunResultSetオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareSearch(String,String)

getHitCountLimit

public int getHitCountLimit()
                     throws ShunException

ソート／集計時のヒット件数の上限値を返却します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。

戻り値:

ソート／集計実行時にヒット件数の上限値。

setHitCountLimitメソッドでヒット件数の上限値を指定していない場合は、 SHUN_NOT_SET_HIT_COUNT_LIMITを返却します。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

setHitCountLimit(int)

setHitCountLimit

public void setHitCountLimit(int limit)
                      throws ShunException

ソート／集計実行時にヒット件数の上限値を指定します。
ヒット件数が上限値をオーバーした場合は、 ソート／集計処理を中断しアプリケーションにヒット件数およびヒット件数がオーバーしたことを通知します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。

パラメータ:

limit - ソート／集計実行時にヒット件数の上限値を指定します。

1〜100000000の値を指定してください。
設定した内容を無効にしたい場合は、SHUN_RESET_HIT_COUNT_LIMITを指定してください。

例外:

ShunException - Shunsaku Java APIの例外

setRequest

public void setRequest(int position,
                       int requestCount)
                throws ShunException

検索式に一致したデータの何件目から返信するか、 および返信されるデータの最大件数を何件にするかを指定します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。
本メソッドのrequestCountで指定した値がconductor用動作環境ファイルのAnsMaxより大きい場合は、 AnsMaxで設定した値が有効になります。
本メソッドの呼出しが省略された場合、 executeSearchメソッドでは検索式に一致したデータの1件目から返信します。 返信されるデータの最大件数は、conductor用動作環境ファイルのAnsMaxで設定した値になります。

パラメータ:

position - 検索式に一致したデータの何件目から返信するかを指定します。

1以上の値を指定します。

requestCount - 返信されるデータの最大件数を指定します。0以上の値を指定します。

0を指定した場合は、検索式に一致したデータ件数だけを取得できます。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareSearch(String,String), executeSearch()

setRequest

public void setRequest(java.lang.String dataPosition,
                       int requestCount,
                       int direction)
                throws ShunException

取り出したデータの次のデータか直前のデータを取り出すために、 取り出したいデータの取得開始位置または取得終了位置を指定します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedStatementオブジェクトでは、例外が発生します。
本メソッドのrequestCountで指定した値がconductor用動作環境ファイルのAnsMaxより大きい場合は、 AnsMaxで設定した値が有効になります。
本メソッドの呼出しが省略された場合、 executeSearchメソッドでは検索式に一致したデータの1件目から返信します。 返信されるデータの最大件数は、conductor用動作環境ファイルのAnsMaxで設定した値になります。

パラメータ:

dataPosition - データの取得位置

取り出したいデータの取得開始位置または取得終了位置を指定してください。
次のデータを取り出したい場合、 前回の検索時にgetLastPositionメソッドで取得した値を指定します。
直前のデータを取り出したい場合、 前回の検索時にgetFirstPositionメソッドで取得した値を指定します。
nullを指定した場合は、データの1件目から返信します。

requestCount - 返信されるデータの最大件数を指定します。

0以上の値を指定します。
0を指定した場合は、検索式に一致したデータ件数だけを取得できます。

direction - 取り出し方向

SHUN_DIRECTION_FORWARD_EXCLUSIVE、またはSHUN_DIRECTION_BACKWARD_EXCLUSIVEを指定してください。
dataPositionにnullを指定した場合は、0を指定してください。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareSearch(String,String), ShunResultSet.getFirstPosition(), ShunResultSet.getLastPosition(), executeSearch()

setSort

public void setSort(java.lang.String sortExpression)
             throws ShunException

ソート式を指定します。
検索結果をソートする場合や、検索結果を集計する場合にソート式を指定します。
本メソッドは、 ShunConnectionクラスのprepareSearchメソッドで作成されたShunPreparedStatementオブジェクトで有効です。 他のShunPreparedSatementオブジェクトでは、例外が発生します。

パラメータ:

sortExpression - ソート式

ソート式は、1〜65535バイトの範囲で指定してください。
ソート式のサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、 ShunConnectionクラスのgetServerEncodingメソッドで取得することができます。
ソート式の詳細については、“アプリケーション開発ガイド”を参照してください。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunConnection.prepareSearch(String,String)