openGionopenGion
5.8.1.1

org.opengion.hayabusa.io
インタフェース TableWriter

既知の実装クラスの一覧:
AbstractTableWriter, TableWriter_Calc, TableWriter_CalcDef, TableWriter_CalcDefAno, TableWriter_CSV, TableWriter_CSV2, TableWriter_CSV3, TableWriter_Data, TableWriter_Data2, TableWriter_Default, TableWriter_Excel, TableWriter_Fixed, TableWriter_JSON, TableWriter_Properties, TableWriter_T, TableWriter_XML

public interface TableWriter

DBTableModel インターフェース のオブジェクトをPrintWriter を用いて出力する為の,共通インターフェースです。

機能分類
ファイル出力
バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
static java.lang.String CSV_SEPARATOR
          カンマ項目区切り文字
static java.lang.String TAB_SEPARATOR
          タブ項目区切り文字
 
メソッドの概要
 DBTableModel getDBTableModel()
          内部の DBTableModel を返します。
 java.lang.String getHeaderSequence()
          DBTableModelの出力順を返します。
 boolean isAppend()
          DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。
 boolean isExcel()
          このクラスが、EXCEL対応機能を持っているかどうかを返します。
 void setAppend(boolean flag)
          DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうか[true/false]を設定します。
 void setColumns(java.lang.String clms)
          出力先ファイルのカラム列を、外部(タグ)より指定します。
 void setDBTableModel(DBTableModel table, java.lang.String lang)
          DBTableModel をセットします。
 void setEncode(java.lang.String enc)
          読み取り元ファイルのエンコード文字列を指定します。
 void setFilename(java.lang.String filename)
          出力先ファイル名をセットします。
 void setFontName(java.lang.String fontName)
          EXCEL出力時のデフォルトフォント名を設定します。
 void setFontPoint(short point)
          EXCEL出力時のデフォルトフォントポイント数を設定します。
 void setHeaderSequence(java.lang.String headerSequence)
          DBTableModelの出力順をセットします。
 void setParam(java.util.List<HybsEntry> listParam)
          パラメーターリストをセットします。
 void setRefFilename(java.lang.String filename)
          EXCEL雛型参考ファイル名をセットします。
 void setRefSheetName(java.lang.String sheetName)
          EXCEL雛型参考ファイルのシート名を設定します。
 void setSeparator(java.lang.String separator)
          データを書き込む場合の,区切り文字をセットします。
 void setSheetName(java.lang.String sheetName)
          DBTableModelのデータとして書き込むときのシート名を設定します。
 void setSkipRowCount(int skipRowCount)
          データの書き込み開始位置を設定します(初期値:0)。
 void setUseNumber(boolean useNumber)
          行番号情報を、出力する(true)/しない(false)を指定します。
 void setUseRenderer(boolean useRenderer)
          書込処理でコードリソースのラベル変換を行うかどうかを指定します。
 void writeDBTable()
          DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
 void writeDBTable(java.io.PrintWriter writer)
          DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。
 

フィールドの詳細

TAB_SEPARATOR

static final java.lang.String TAB_SEPARATOR
タブ項目区切り文字

関連項目:
定数フィールド値

CSV_SEPARATOR

static final java.lang.String CSV_SEPARATOR
カンマ項目区切り文字

関連項目:
定数フィールド値
メソッドの詳細

writeDBTable

void writeDBTable()
DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。 このメソッドは、EXCEL 書き出し時に使用します。

関連項目:
isExcel()
変更履歴:
4.0.0.0 (2006/09/31) 新規追加

writeDBTable

void writeDBTable(java.io.PrintWriter writer)
DBTableModel から 各形式のデータを作成して,PrintWriter に書き出します。

パラメータ:
writer - PrintWriterオブジェクト
変更履歴:
3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。

setDBTableModel

void setDBTableModel(DBTableModel table,
                     java.lang.String lang)
DBTableModel をセットします。

パラメータ:
table - DBTableModelオブジェクト
lang - 言語
変更履歴:
3.5.4.2 (2003/12/15) lang 引数も同時に設定します。

getDBTableModel

DBTableModel getDBTableModel()
内部の DBTableModel を返します。

戻り値:
DBTableModelオブジェクト

setHeaderSequence

void setHeaderSequence(java.lang.String headerSequence)
DBTableModelの出力順をセットします。 Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。

パラメータ:
headerSequence - 出力順 (LNSCD など)

getHeaderSequence

java.lang.String getHeaderSequence()
DBTableModelの出力順を返します。 Label,Name,Size,Class,Data の各フィールドの頭文字のアルファベットで 出力順を設定します。

戻り値:
出力順 (LNSCD など)

setSeparator

void setSeparator(java.lang.String separator)
データを書き込む場合の,区切り文字をセットします。 なお,このメソッドは,サブクラスによっては,使用しない場合があります。 もし,使用しないサブクラスを作成する場合は, UnsupportedOperationException を throw するように,サブクラスで実装して下さい。

パラメータ:
separator - 区切り文字

setAppend

void setAppend(boolean flag)
DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうか[true/false]を設定します。

パラメータ:
flag - 追加モードで書き込むかどうか[true:追加モード/false:通常モード]
変更履歴:
3.5.4.2 (2003/12/15) 新規追加

isAppend

boolean isAppend()
DBTableModelのデータとして書き込むときに、追加モードで書き込むかどうかを取得します。

戻り値:
追加モードで書き込むかどうか[true:追加モード/false:通常モード]
変更履歴:
3.5.4.2 (2003/12/15) 新規追加

setSheetName

void setSheetName(java.lang.String sheetName)
DBTableModelのデータとして書き込むときのシート名を設定します。 これは、EXCEL追加機能として実装されています。

パラメータ:
sheetName - シート名
変更履歴:
3.5.4.2 (2003/12/15) 新規追加

setRefSheetName

void setRefSheetName(java.lang.String sheetName)
EXCEL雛型参考ファイルのシート名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、雛型として参照するシート名を指定します。 これにより、複数の形式の異なるデータを順次書き出したり(appendモードを併用)する ことや、シートを指定して新規にEXCELを作成する場合にフォームを設定する事が可能になります。 初期値は、null(第一シート) です。

パラメータ:
sheetName - シート名
変更履歴:
3.5.4.3 (2004/01/05) 新規追加

isExcel

boolean isExcel()
このクラスが、EXCEL対応機能を持っているかどうかを返します。 EXCEL対応機能とは、シート名のセット、雛型参照ファイル名のセット、 書き込み元ファイルのFileオブジェクト取得などの、特殊機能です。 本来は、インターフェースを分けるべきと考えますが、taglib クラス等の 関係があり、問い合わせによる条件分岐で対応します。

戻り値:
EXCEL対応機能を持っているかどうか
変更履歴:
3.5.4.3 (2004/01/05) 新規追加

setFilename

void setFilename(java.lang.String filename)
出力先ファイル名をセットします。(DIR + Filename) これは、EXCEL追加機能として実装されています。

パラメータ:
filename - 出力先ファイル名
変更履歴:
3.5.4.3 (2004/01/05) 新規作成

setRefFilename

void setRefFilename(java.lang.String filename)
EXCEL雛型参考ファイル名をセットします。(DIR + Filename) これは、EXCEL追加機能として実装されています。

パラメータ:
filename - EXCEL雛型参考ファイル名
変更履歴:
3.5.4.3 (2004/01/05) 新規作成

setEncode

void setEncode(java.lang.String enc)
読み取り元ファイルのエンコード文字列を指定します。 ファイルは、BufferedReader で受け取る為、本来は、エンコードは不要ですが、 固定長ファイルの読み取り時のバイトコード分割時に、指定のエンコードで 分割する必要があります。(例えば、半角文字は、Shift_JIS では、1バイト)

パラメータ:
enc - ファイルのエンコード文字列
変更履歴:
3.5.4.5 (2004/01/23) 新規作成

setUseNumber

void setUseNumber(boolean useNumber)
行番号情報を、出力する(true)/しない(false)を指定します。 通常のフォーマットでは、各行の先頭に行番号を出力します。 これは、#NAME 属性を使用する場合には、必ず出力する必要があります。 (#NAME 属性は、読み取り時には、必須です。) この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力、 このシステムでは、#NAME 属性が出力されないため、読み込みできません。) この行番号を出力しないようにできます。 初期値は、true(出力する) です。

パラメータ:
useNumber - 行番号情報 [true:出力する/false:しない]
変更履歴:
3.7.0.2 (2005/02/14) 新規追加

setParam

void setParam(java.util.List<HybsEntry> listParam)
パラメーターリストをセットします。 内部は、HybsEntry クラスを持っています。 引数が、null の場合は、何もしません。

パラメータ:
listParam - パラメーターリスト
変更履歴:
4.0.0.0 (2005/01/31) 新規追加

setColumns

void setColumns(java.lang.String clms)
出力先ファイルのカラム列を、外部(タグ)より指定します。 ただし、指定のカラム名は、DBTableModel上に存在している必要があります。

パラメータ:
clms - 出力先ファイルのカラム列(カンマ区切り文字)
変更履歴:
4.0.0.0 (2005/11/30) 新規追加

setFontName

void setFontName(java.lang.String fontName)
EXCEL出力時のデフォルトフォント名を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトフォント名を指定します。 フォント名は、EXCELのフォント名をそのまま使用してください。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontName( String ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_NAME です。

パラメータ:
fontName - デフォルトフォント名
変更履歴:
3.8.5.3 (2006/08/07) 新規追加

setFontPoint

void setFontPoint(short point)
EXCEL出力時のデフォルトフォントポイント数を設定します。 これは、EXCEL追加機能として実装されています。 EXCELファイルを書き出す時に、デフォルトポイント数を指定します。 内部的に、POI の org.apache.poi.hssf.usermodel.HSSFFont#setFontHeightInPoints( short ) に設定されます。 初期値は、システムリソース の TABLE_WRITER_DEFAULT_FONT_POINTS です。

パラメータ:
point - フォントポイント数
変更履歴:
3.8.5.3 (2006/08/07) 新規追加

setSkipRowCount

void setSkipRowCount(int skipRowCount)
データの書き込み開始位置を設定します(初期値:0)。 TAB区切りテキストやEXCEL等のデータの書き込みの開始位置を指定します。 属性名は、行を飛ばす処理ということで、readTable タグと同じ名称です。 ファイルの先頭行が、0行としてカウントしますので、設定値は、読み飛ばす 件数になります。(1と指定すると、1件読み飛ばし、2行目から読み込みます。) 行の読み飛ばしと、カラムの読み飛ばし(columns)、refFileURL、refFilename、 refSheetName とともに使用すれば、ある程度のレイアウト設定が可能です。 なお、この機能は、TableWriter_Excel のみに実装します。

パラメータ:
skipRowCount - 書き込み開始位置
変更履歴:
5.7.9.0 (2014/08/08) 新規作成

setUseRenderer

void setUseRenderer(boolean useRenderer)
書込処理でコードリソースのラベル変換を行うかどうかを指定します。 コードリソースをそのままの値で出力すると、数字や記号になり何が書かれているのか 不明になります。 これは、コードリソースをラベルに変換して出力するかどうかを指定します。 当然、コードはユニークですが、ラベルはユニークになるかどうか保障はされていませんので TableReader 系で読み込む場合には、リスクが発生します。 また、TableReader 系で読み込む場合にも、ラベルからコードを求める逆変換を行うように、 setUseRenderer メソッドで指定する必要があります。 従来は、TableWriter 系に、TableWriter_Renderer 系のクラスを作って対応していましたが、 このメソッドの属性値のフラグで、制御します。

パラメータ:
useRenderer - コードリソースのラベル変換を行うかどうかを指定
変更履歴:
5.2.1.0 (2010/10/01) 新規作成

openGion 5.8.1.1

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.