nablarch.common.web.download

Class DataRecordResponse

java.lang.Object

nablarch.fw.web.HttpResponse

nablarch.common.web.download.DataRecordResponse

All Implemented Interfaces:

Result

public class DataRecordResponse
extends HttpResponse

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

Nested Class Summary

Nested classes/interfaces inherited from class nablarch.fw.web.HttpResponse

HttpResponse.Status

Nested classes/interfaces inherited from interface nablarch.fw.Result

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

Field Summary

Fields inherited from class nablarch.fw.web.HttpResponse

CONTENT_DISPOSITION, LS

Constructor Summary

Constructors

Constructor and Description
DataRecordResponse(java.lang.String basePathName, java.lang.String fileName) コンストラクタ。 フォーマット定義ファイルを元に、使用するDataRecordFormatterを設定する。

Method Summary

Modifier and Type	Method and Description
HttpResponse	cleanup() リソースを開放する。
void	write(java.util.Map<java.lang.String,?> record) メッセージボディに1レコード分のデータを書き込む。 データレイアウト(レコードタイプ）の決定方法については DataRecordFormatter.writeRecord(Map)を参照すること。
void	write(java.lang.String recordType, java.util.Map<java.lang.String,?> record) データレイアウト(レコードタイプ）を指定して、メッセージボディに1レコード分のデータを書き込む。

Methods inherited from class nablarch.fw.web.HttpResponse

addCookie, getBodyStream, getBodyString, getCharset, getContentDisposition, getContentLength, getContentPath, getContentType, getCookie, getCookieList, getHeader, getHeaderMap, getHttpCookies, getHttpVersion, getLocation, getMessage, getReasonPhrase, getStatusCode, getTransferEncoding, isBodyEmpty, isSuccess, parse, parse, setBodyStream, setContentDisposition, setContentDisposition, setContentPath, setContentPath, setContentType, setCookie, setHeader, setHttpVersion, setLocation, setStatusCode, setTransferEncoding, toString, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataRecordResponse

@Published
public DataRecordResponse(java.lang.String basePathName,
                                     java.lang.String fileName)

コンストラクタ。

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

Parameters:

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

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

Method Detail

write

@Published
public void write(java.util.Map<java.lang.String,?> record)

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

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

Parameters:

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

Throws:

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

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

See Also:

DataRecordFormatter.writeRecord(Map)

write

@Published
public void write(java.lang.String recordType,
                             java.util.Map<java.lang.String,?> record)

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

Parameters:

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

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

Throws:

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

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

See Also:

DataRecordFormatter.writeRecord(String, Map)

cleanup

public HttpResponse cleanup()

Description copied from class: HttpResponse

リソースを開放する。

Overrides:

cleanup in class HttpResponse

Returns:

本オブジェクト