jp.co.intra_mart.foundation.viewcreator.expansion

インタフェース VCResource

すべてのスーパーインタフェース:

AutoCloseable, Closeable

既知のサブインタフェースのリスト:

VCResourceWithTable

既知の実装クラスのリスト:

CSVResource, LDFlowResource, LogResource, ResourceWithTable, TextResource

public interface VCResource
extends Closeable

ViewCreatorで外部データリソースを取り扱うためのインタフェースです。

バージョン:

8.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	beforeFirst() リソースの参照を初期位置に戻します。
VCResultSet	getDataSet(SearchCondition[] conditions, boolean orsearch, SortField[] fields) 指定された検索条件でデータセットを取得します。
TextField[]	getFields() このリソースが保持するフィールド定義を取得します。
int	getMaxGroupingRecordCount() リスト集計でグループ化を行った場合の、最大グループ数を取得します。
String	getName() リソース名を取得します。
VCRecord	readLine() リソースから1レコード読み込みます。

インタフェースから継承されたメソッド java.io.Closeable

close

メソッドの詳細

beforeFirst

void beforeFirst()
          throws VCResourceException

リソースの参照を初期位置に戻します。

例外:

VCResourceException - 処理に失敗したときスローされます

getDataSet

VCResultSet getDataSet(SearchCondition[] conditions,
                       boolean orsearch,
                       SortField[] fields)
                throws VCResourceException

指定された検索条件でデータセットを取得します。

パラメータ:

conditions - 検索条件の配列

orsearch - OR検索フラグ

fields - ソート列情報の配列

戻り値:

結果データセット

例外:

VCResourceException - データ読み取り中にエラーが発生した場合にスローされます

getFields

TextField[] getFields()

このリソースが保持するフィールド定義を取得します。

戻り値:

フィールドの配列

getMaxGroupingRecordCount

int getMaxGroupingRecordCount()

リスト集計でグループ化を行った場合の、最大グループ数を取得します。
OutOfMemoryErrorを発生させないために、取得された数値より多いグループ数になった場合は オーバーフローした分を表示データから切り捨てられます。

戻り値:

最大グループ数

getName

String getName()

リソース名を取得します。

戻り値:

リソース名

readLine

VCRecord readLine()
           throws VCResourceException

リソースから1レコード読み込みます。
配列の要素には、フィールド単位のデータが格納されます。
また配列の順序は、getFieldsで取得されるフィールドの順序と対応関係にあります。
これ以上読み込むデータが無い場合はnullが返却されます。

戻り値:

1レコード分のデータ

例外:

VCResourceException - 処理に失敗したときスローされます