com.fujitsu.shun
クラス ShunResultSet

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

public class ShunResultSet

extends java.lang.Object

検索した結果を表現するクラスです。
nextメソッド実行後、getStringメソッド、getStreamメソッドまたはgetStringArrayメソッドの いずれかを実行することで、1件ずつデータを取得することができます。
ShunResultSetオブジェクトは、ShunPreparedStatementクラスのexecuteSearchメソッド、 ShunPreparedRecordIDクラスのsearchByRecordIDメソッドまたはShunPreparedKeyクラスのsearchByKeyメソッドで作成します。

関連項目:

ShunPreparedStatement.executeSearch(), ShunPreparedRecordID.searchByRecordID(), ShunPreparedKey.searchByKey()

メソッドの概要

void	close() ShunResultSetオブジェクトを解放します。
java.lang.String	getFirstPosition() Shunsakuから取り出したデータの先頭位置情報を返却します。
int	getHitCount() 検索式、ダイレクトアクセスキーまたは指定したレコードIDに一致したデータのヒット件数を返却します。
java.lang.String	getKey() 現在のXML文書のダイレクトアクセスキーを返却します。
java.lang.String	getLastPosition() Shunsakuから取り出したデータの最終位置情報を返却します。
java.lang.String	getRecordID() 現在のXML文書のレコードIDを返却します。
int	getReturnableCount() 返却可能なデータの最大件数を返却します。
int	getReturnCount() Shunsakuから取り出したデータの件数を返却します。
int	getRow() 現在のデータがShunResultSetオブジェクトに保持しているデータの何番目であるかを返します。
java.io.InputStream	getStream() 現在のデータを、Unicode(UTF-8)に変換してInputStreamとして返却します。
java.lang.String	getString() 現在のデータを、Stringとして返却します。
java.lang.String[][]	getStringArray() 現在のデータを、リターン項目単位にStringの2次元配列として返却します。
boolean	isHitCountLimitOver() ヒット件数が上限を超えているかどうかの状態を返却します。
boolean	next() 次のデータに移動します。

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

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

メソッドの詳細

close

public void close()
           throws ShunException

ShunResultSetオブジェクトを解放します。
ShunResultSetオブジェクトは、このオブジェクトを作成したShunPreparedStatementオブジェクト、 ShunPreparedRecordIDオブジェクトまたはShunPreparedKeyオブジェクトが解放されるときに解放されます。
ShunResultSetオブジェクトは、 このオブジェクトを作成したShunPreparedStatementオブジェクトまたはShunPreparedRecordIDオブジェクトを使用して、 新たにShunResultSetオブジェクトを作成したときに解放されます。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement.close(), ShunPreparedRecordID.close(), ShunPreparedKey.close()

getFirstPosition

public java.lang.String getFirstPosition()
                                  throws ShunException

Shunsakuから取り出したデータの先頭位置情報を返却します。
検索した結果を一定件数ごとに区切り、前後に連続したデータを取得したい場合に使用します。
本メソッドは、 ShunPreparedStatementクラスのexecuteSearchメソッドで作成されたShunResultSetオブジェクトで有効です。 他のShunResultSetオブジェクトでは、nullを返却します。

戻り値:

取り出したデータの先頭位置情報

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement

getHitCount

public int getHitCount()
                throws ShunException

検索式、ダイレクトアクセスキーまたは指定したレコードIDに一致したデータのヒット件数を返却します。

戻り値:

検索式、ダイレクトアクセスキーまたは指定したレコードIDに一致したデータのヒット件数

検索式、ダイレクトアクセスキーまたは指定したレコードIDに一致したデータが存在しない場合は0を返却します。

例外:

ShunException - Shunsaku Java APIの例外

getKey

public java.lang.String getKey()
                        throws ShunException

現在のXML文書のダイレクトアクセスキーを返却します。
本メソッドは、 ShunPreparedKeyクラスのsearchByKeyメソッドで作成されたShunResultSetオブジェクトで有効です。 他のShunResultSetオブジェクトでは、nullを返却します。

例外:

ShunException - Shunsaku Java APIの例外

getLastPosition

public java.lang.String getLastPosition()
                                 throws ShunException

Shunsakuから取り出したデータの最終位置情報を返却します。
検索した結果を一定件数ごとに区切り、前後に連続したデータを取得したい場合に使用します。
本メソッドは、 ShunPreparedStatementクラスのexecuteSearchメソッドで作成されたShunResultSetオブジェクトで有効です。 他のShunResultSetオブジェクトでは、nullを返却します。

戻り値:

取り出したデータの最終位置情報

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement

getRecordID

public java.lang.String getRecordID()
                             throws ShunException

現在のXML文書のレコードIDを返却します。

戻り値:

レコードID

例外:

ShunException - Shunsaku Java APIの例外

getReturnableCount

public int getReturnableCount()
                       throws ShunException

返却可能なデータの最大件数を返却します。
ShunPreparedStatementクラスのsetSortメソッドを使用してソートまたは集計を行う場合、 setSortメソッドで指定するソートキーまたはグループキーの長さによって、 返却できる件数が異なります。
ソートキーまたはグループキーの長さと返却可能なデータの最大件数の目安については、 “アプリケーション開発ガイド”の“定量値”を参照してください。
setSortメソッドを使用しない場合、本メソッドの戻り値は、 getHitCountメソッドの戻り値と同じになります。
ヒット件数が上限を超えている場合には、0を返却します。

戻り値:

指定された検索式で返却可能なデータの最大件数

返却可能なデータが存在しない場合は 0を返却します。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement.setSort(String), getHitCount()

getReturnCount

public int getReturnCount()
                   throws ShunException

Shunsakuから取り出したデータの件数を返却します。

戻り値:

Shunsakuから取り出したデータの件数

データが存在しない場合は 0を返却します。

例外:

ShunException - Shunsaku Java APIの例外

getRow

public int getRow()
           throws ShunException

現在のデータがShunResultSetオブジェクトに保持しているデータの何番目であるかを返します。 先頭のデータは1番目、その次のデータは2番目となります。

戻り値:

現在の位置の番号

nextメソッドが実行されていない場合またはデータが存在しない場合は、0を返却します。

例外:

ShunException - Shunsaku Java APIの例外

getStream

public java.io.InputStream getStream()
                              throws ShunException

現在のデータを、Unicode(UTF-8)に変換してInputStreamとして返却します。
ShunResultSetオブジェクトが作成されたあとにnextメソッドが実行されていない、 またはnextメソッドがfalseを返却したあとに、本メソッドを呼び出した場合は、 例外が発生します。

戻り値:

検索されたデータ

例外:

ShunException - Shunsaku Java APIの例外

getString

public java.lang.String getString()
                           throws ShunException

現在のデータを、Stringとして返却します。
ShunResultSetオブジェクトが作成されたあとにnextメソッドが実行されていない、 またはnextメソッドがfalseを返却したあとに、本メソッドを呼び出した場合は、 例外が発生します。

戻り値:

検索されたデータ

例外:

ShunException - Shunsaku Java APIの例外

getStringArray

public java.lang.String[][] getStringArray()
                                    throws ShunException

現在のデータを、リターン項目単位にStringの2次元配列として返却します。
上位配列の要素数は、リターン式の数です。
下位配列の要素数は、指定されたリターン式に該当するデータが1文書内に存在する数です。
配列の要素には、検索されたデータを返却します。
ShunResultSetオブジェクトが作成されたあとにnextメソッドが実行されていない、 またはnextメソッドがfalseを返却したあとに、本メソッドを呼び出した場合は、例外が発生します。
本メソッドは、リターン式にテキスト式が指定されたときに有効です。

戻り値:

検索されたデータ

例外:

ShunException - Shunsaku Java APIの例外

isHitCountLimitOver

public boolean isHitCountLimitOver()
                            throws ShunException

ヒット件数が上限を超えているかどうかの状態を返却します。

戻り値:

ヒット件数が上限を超えた場合はtrue、そうでない場合はfalse

trueが返却された場合は、ソート／集計を中断し、ヒット件数のみを返却します。
ShunPreparedStatementクラスのsetHitCountLimitメソッドでヒット件数の上限値を指定していない、 またはソート／集計を実行していない場合は、falseを返却します。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement

next

public boolean next()
             throws ShunException

次のデータに移動します。

戻り値:

次のデータが存在する場合はtrue、それ以上データがない場合はfalse

例外:

ShunException - Shunsaku Java APIの例外