nablarch.core.dataformat

インタフェース DataRecordFormatter

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

java.lang.AutoCloseable, java.io.Closeable

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

DataRecordFormatterSupport, FixedLengthDataRecordFormatter, JsonDataRecordFormatter, StructuredDataRecordFormatterSupport, VariableLengthDataRecordFormatter, XmlDataRecordFormatter

@Published
public interface DataRecordFormatter
extends java.io.Closeable

データファイルとJavaオブジェクトのシリアライズ／デシリアライズを行うクラスが実装するインタフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close() 内部的に保持している各種リソースを開放する。
int	getRecordNumber() 読み込みまたは書き込み中のレコードのレコード番号を返却する。
boolean	hasNext() 次に読み込む行の有無を判定する。
DataRecordFormatter	initialize() 初期化処理を行う。
DataRecord	readRecord() 入力ストリームから1レコード分のデータを読み込み、データレコードを返却する。
DataRecordFormatter	setDefinition(LayoutDefinition definition) フォーマット定義ファイルの情報を保持するクラスを設定する。
DataRecordFormatter	setInputStream(java.io.InputStream stream) 入力ストリームを設定する。
DataRecordFormatter	setOutputStream(java.io.OutputStream stream) 出力ストリームを設定する。
void	writeRecord(java.util.Map<java.lang.String,?> record) 出力ストリームに1レコード分の内容を書き込む。
void	writeRecord(java.lang.String recordType, java.util.Map<java.lang.String,?> record) 指定したデータレイアウト（レコードタイプ）で、出力ストリームに1レコード分の内容を書き込む。

メソッドの詳細

readRecord

DataRecord readRecord()
               throws java.io.IOException,
                      InvalidDataFormatException

入力ストリームから1レコード分のデータを読み込み、データレコードを返却する。 入力ストリームが既に終端に達していた場合はnullを返却する。

戻り値:

データレコード

例外:

java.io.IOException - 入力ストリームの読み込みに失敗した場合

InvalidDataFormatException - 読み込んだデータがフォーマット定義に違反している場合

writeRecord

void writeRecord(java.util.Map<java.lang.String,?> record)
          throws java.io.IOException,
                 InvalidDataFormatException

出力ストリームに1レコード分の内容を書き込む。

出力時に使用するデータレイアウト（レコードタイプ）は、Mapの内容をもとに自動的に判定される。

引数がDataRecord型かつレコードタイプが指定されている場合、 フォーマット定義ファイルのレコードタイプ識別フィールド定義よりも、指定されたレコードタイプを優先して書き込みを行う。

パラメータ:

record - 出力するレコードの内容を格納したMap

例外:

java.io.IOException - 出力ストリームの書き込みに失敗した場合

InvalidDataFormatException - 書き込むデータの内容がフォーマット定義に違反している場合

writeRecord

void writeRecord(java.lang.String recordType,
                 java.util.Map<java.lang.String,?> record)
          throws java.io.IOException,
                 InvalidDataFormatException

指定したデータレイアウト（レコードタイプ）で、出力ストリームに1レコード分の内容を書き込む。

パラメータ:

recordType - レコードタイプ

record - 出力するレコードの内容を格納したMap

例外:

java.io.IOException - 出力ストリームの書き込みに失敗した場合

InvalidDataFormatException - 書き込むデータの内容がフォーマット定義に違反している場合

initialize

DataRecordFormatter initialize()

初期化処理を行う。

戻り値:

本クラスのインスタンス

setInputStream

DataRecordFormatter setInputStream(java.io.InputStream stream)

入力ストリームを設定する。

パラメータ:

stream - 入力ストリーム

戻り値:

本クラスのインスタンス

close

void close()

内部的に保持している各種リソースを開放する。

定義:

close インタフェース内 java.lang.AutoCloseable

定義:

close インタフェース内 java.io.Closeable

setDefinition

DataRecordFormatter setDefinition(LayoutDefinition definition)

フォーマット定義ファイルの情報を保持するクラスを設定する。

パラメータ:

definition - フォーマット定義ファイルの定義情報

戻り値:

本クラスのインスタンス

setOutputStream

DataRecordFormatter setOutputStream(java.io.OutputStream stream)

出力ストリームを設定する。

パラメータ:

stream - 出力ストリーム

戻り値:

本クラスのインスタンス

hasNext

boolean hasNext()
         throws java.io.IOException

次に読み込む行の有無を判定する。

戻り値:

次に読み込む行がある場合true

例外:

java.io.IOException - 入力ストリームの読み込みに失敗した場合

getRecordNumber

int getRecordNumber()

読み込みまたは書き込み中のレコードのレコード番号を返却する。

戻り値:

レコード番号