nablarch.common.web.download

クラス DataRecordResponse

java.lang.Object

nablarch.fw.web.HttpResponse

nablarch.common.web.download.DataRecordResponse

すべての実装されたインタフェース:

Result

public class DataRecordResponse
extends HttpResponse

Map型のデータレコードのリストを一定のフォーマットに従って直列化し、 その内容をレスポンスボディとするHTTPレスポンスオブジェクト。

作成者:

Kiyohito Itoh

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース nablarch.fw.web.HttpResponse

HttpResponse.Status

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result

Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DataRecordResponse(String basePathName, String fileName) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	write(Map<?> record) メッセージボディに1レコード分のデータを書き込む。
void	write(String recordType, Map<?> record) データレイアウト(レコードタイプ）を指定して、メッセージボディに1レコード分のデータを書き込む。

クラスから継承されたメソッド nablarch.fw.web.HttpResponse

addCookie, getBodyStream, getBodyString, getContentDisposition, getContentLength, getContentPath, getContentType, getCookie, getHeader, getHeaderMap, getHttpVersion, getLocation, getMessage, getReasonPhrase, getStatusCode, isBodyEmpty, setBodyStream, setContentDisposition, setContentDisposition, setContentPath, setContentPath, setContentType, setCookie, setHeader, setLocation, setStatusCode, write, write, write

インタフェースから継承されたメソッド nablarch.fw.Result

isSuccess

コンストラクタの詳細

DataRecordResponse

@Published
public DataRecordResponse(String basePathName,
                                     String fileName)

コンストラクタ。

フォーマット定義ファイルを元に、使用するDataRecordFormatterを設定する。

パラメータ:

basePathName - フォーマット定義ファイルのベースパス論理名

fileName - フォーマット定義ファイルのファイル名

メソッドの詳細

write

@Published
public void write(Map<?> record)

メッセージボディに1レコード分のデータを書き込む。

データレイアウト(レコードタイプ）の決定方法については DataRecordFormatter.writeRecord(Map)を参照すること。

パラメータ:

record - 1レコード分のデータ

例外:

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

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

関連項目:

DataRecordFormatter.writeRecord(Map)

write

@Published
public void write(String recordType,
                             Map<?> record)

データレイアウト(レコードタイプ）を指定して、メッセージボディに1レコード分のデータを書き込む。

パラメータ:

recordType - 出力時に使用するデータレイアウト

record - 1レコード分のデータ

例外:

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

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

関連項目:

DataRecordFormatter.writeRecord(String, Map)