jp.sf.orangesignal.trading.stats.report
クラス TextFileReporter

java.lang.Object
  上位を拡張 jp.sf.orangesignal.trading.stats.report.TextFileReporter
すべての実装されたインタフェース:
Reporter

public class TextFileReporter
extends Object
implements Reporter

パフォーマンス情報をテキストファイルへ出力する Reporter の実装クラスを提供します。

作成者:
杉澤 浩二

フィールドの概要
protected static String DEFAULT_BASE_PATH
          テンプレートやリソースを読込むデフォルトのパスです。
protected static String DEFAULT_ENCODING
          デフォルトのエンコーディングです。
protected static Configuration defaultConfig
          デフォルトの FreeMarker 設定情報です。
protected static List<String> defaultResourceList
          デフォルトの画像やスタイルシートなどのリソース名のリストです。
protected static Map<String,String> defaultStatsTemplateMap
          デフォルトのパフォーマンス統計テンプレート名とファイル名のマップです。
protected static Map<String,String> defaultSummaryTemplateMap
          デフォルトのパフォーマンス概要テンプレート名とファイル名のマップです。
protected  String dir
          出力ディレクトリを保持します。
protected  Configuration freemarker
          FreeMarker 設定情報を保持します。
static String KEY_BACKTESTER
          バックテスト実行オブジェクトのキー名です。
static String KEY_LONG_STATS
          買いパフォーマンス統計情報のキー名です。
static String KEY_LOSS_STATS
          負けパフォーマンス統計情報のキー名です。
static String KEY_LOSS_SUMMARY
          負けパフォーマンス概要情報のキー名です。
static String KEY_SHORT_STATS
          売りパフォーマンス統計情報のキー名です。
static String KEY_STATS
          パフォーマンス統計情報のキー名です。
static String KEY_STATS_MAP
          パフォーマンス統計情報マップのキー名です。
static String KEY_SUMMARY
          パフォーマンス概要情報のキー名です。
static String KEY_SYMBOL
          シンボルのキー名です。
static String KEY_SYMBOL_NAME
          シンボル名のキー名です。
static String KEY_TIMESTAMP
          レポート作成日時のキー名です。
static String KEY_TRADE_LIST
          トレード情報のリストのキー名です。
static String KEY_WIN_STATS
          勝ちパフォーマンス統計情報のキー名です。
static String KEY_WIN_SUMMARY
          勝ちパフォーマンス概要情報のキー名です。
protected static Log log
          共通ログインスタンスです。
protected  List<String> resourceList
          画像やスタイルシートなどのリソース名のリストを保持します。
protected  Map<String,String> statsTemplateMap
          パフォーマンス統計テンプレート名とファイル名のマップを保持します。
protected  Map<String,String> summaryTemplateMap
          パフォーマンス概要テンプレート名とファイル名のマップを保持します。
 
コンストラクタの概要
TextFileReporter()
          デフォルトコンストラクタです。
 
メソッドの概要
protected  void copyResources()
          リソースをコピーします。
protected static void marge(Template template, Map<String,Object> model, String filename)
          指定されたテンプレートとコンテキストパラメータをマージして指定されたファイルへ保存します。
protected static void marge(Template template, Map<String,Object> model, String filename, String encoding)
          指定されたテンプレートとコンテキストパラメータをマージして指定されたファイルへ保存します。
 void report(Stats stats)
          実装は単に、report(Stats, boolean) をリソースをコピーするとして呼出すだけです。
 void report(Stats stats, boolean copyResources)
          パフォーマンス統計情報を出力します。
 void report(Summary summary, Backtester backtester)
          実装は単に、report(Summary, Backtester, boolean) をリソースをコピーするとして呼出すだけです。
 void report(Summary summary, Backtester backtester, boolean copyResources)
          パフォーマンス概要情報を出力します。
 void setDir(String dir)
          出力ディレクトリを設定します。
 void setFreemarker(Configuration freemarker)
          FreeMarker 設定情報を設定します。
 void setResourceList(List<String> resourceList)
          画像やスタイルシートなどのリソース名のリストを設定します。
 void setStatsTemplateMap(Map<String,String> statsTemplateMap)
          パフォーマンス統計テンプレート名とファイル名のマップを設定します。
 void setSummaryTemplateMap(Map<String,String> summaryTemplateMap)
          パフォーマンス概要テンプレート名とファイル名のマップを設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

log

protected static final Log log
共通ログインスタンスです。


DEFAULT_BASE_PATH

protected static final String DEFAULT_BASE_PATH
テンプレートやリソースを読込むデフォルトのパスです。

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

DEFAULT_ENCODING

protected static final String DEFAULT_ENCODING
デフォルトのエンコーディングです。

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

defaultConfig

protected static Configuration defaultConfig
デフォルトの FreeMarker 設定情報です。


defaultSummaryTemplateMap

protected static final Map<String,String> defaultSummaryTemplateMap
デフォルトのパフォーマンス概要テンプレート名とファイル名のマップです。


defaultStatsTemplateMap

protected static final Map<String,String> defaultStatsTemplateMap
デフォルトのパフォーマンス統計テンプレート名とファイル名のマップです。


defaultResourceList

protected static final List<String> defaultResourceList
デフォルトの画像やスタイルシートなどのリソース名のリストです。


freemarker

protected Configuration freemarker
FreeMarker 設定情報を保持します。


summaryTemplateMap

protected Map<String,String> summaryTemplateMap
パフォーマンス概要テンプレート名とファイル名のマップを保持します。


statsTemplateMap

protected Map<String,String> statsTemplateMap
パフォーマンス統計テンプレート名とファイル名のマップを保持します。


resourceList

protected List<String> resourceList
画像やスタイルシートなどのリソース名のリストを保持します。


dir

protected String dir
出力ディレクトリを保持します。


KEY_TIMESTAMP

public static final String KEY_TIMESTAMP
レポート作成日時のキー名です。

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

KEY_BACKTESTER

public static final String KEY_BACKTESTER
バックテスト実行オブジェクトのキー名です。

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

KEY_SUMMARY

public static final String KEY_SUMMARY
パフォーマンス概要情報のキー名です。

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

KEY_WIN_SUMMARY

public static final String KEY_WIN_SUMMARY
勝ちパフォーマンス概要情報のキー名です。

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

KEY_LOSS_SUMMARY

public static final String KEY_LOSS_SUMMARY
負けパフォーマンス概要情報のキー名です。

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

KEY_STATS_MAP

public static final String KEY_STATS_MAP
パフォーマンス統計情報マップのキー名です。

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

KEY_SYMBOL

public static final String KEY_SYMBOL
シンボルのキー名です。

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

KEY_SYMBOL_NAME

public static final String KEY_SYMBOL_NAME
シンボル名のキー名です。

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

KEY_STATS

public static final String KEY_STATS
パフォーマンス統計情報のキー名です。

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

KEY_LONG_STATS

public static final String KEY_LONG_STATS
買いパフォーマンス統計情報のキー名です。

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

KEY_SHORT_STATS

public static final String KEY_SHORT_STATS
売りパフォーマンス統計情報のキー名です。

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

KEY_WIN_STATS

public static final String KEY_WIN_STATS
勝ちパフォーマンス統計情報のキー名です。

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

KEY_LOSS_STATS

public static final String KEY_LOSS_STATS
負けパフォーマンス統計情報のキー名です。

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

KEY_TRADE_LIST

public static final String KEY_TRADE_LIST
トレード情報のリストのキー名です。

関連項目:
定数フィールド値
コンストラクタの詳細

TextFileReporter

public TextFileReporter()
デフォルトコンストラクタです。

メソッドの詳細

setFreemarker

public void setFreemarker(Configuration freemarker)
FreeMarker 設定情報を設定します。

パラメータ:
freemarker - FreeMarker 設定情報

setSummaryTemplateMap

public void setSummaryTemplateMap(Map<String,String> summaryTemplateMap)
パフォーマンス概要テンプレート名とファイル名のマップを設定します。

パラメータ:
summaryTemplateMap - パフォーマンス概要テンプレート名とファイル名のマップ

setStatsTemplateMap

public void setStatsTemplateMap(Map<String,String> statsTemplateMap)
パフォーマンス統計テンプレート名とファイル名のマップを設定します。

パラメータ:
statsTemplateMap - パフォーマンス統計テンプレート名とファイル名のマップ

setResourceList

public void setResourceList(List<String> resourceList)
画像やスタイルシートなどのリソース名のリストを設定します。

パラメータ:
resourceList - 画像やスタイルシートなどのリソース名のリスト

setDir

public void setDir(String dir)
出力ディレクトリを設定します。

パラメータ:
dir - 出力ディレクトリ

report

public void report(Summary summary,
                   Backtester backtester)
            throws IOException
実装は単に、report(Summary, Backtester, boolean) をリソースをコピーするとして呼出すだけです。

定義:
インタフェース Reporter 内の report
パラメータ:
summary - パフォーマンス概要情報
backtester - バックテスト実行オブジェクト
例外:
IOException - 入出力操作で例外が発生した場合
関連項目:
report(Summary, Backtester, boolean)

report

public void report(Summary summary,
                   Backtester backtester,
                   boolean copyResources)
            throws IOException

パフォーマンス概要情報を出力します。

実装は、FreeMarker を使用してテンプレートファイルからレポートを生成します。
テンプレート中で使用可能なオブジェクトの定義を以下に記載します。

このメソッドはパフォーマンス概要情報出力後に全てのパフォーマンス統計情報について、report(Stats, boolean) をリソースをコピーしないとして呼出します。

パラメータ:
summary - パフォーマンス概要情報
backtester - バックテスト実行オブジェクト
copyResources - 画像やスタイルシートなどのリソースを出力ディレクトへコピーするかどうか
例外:
IOException - 入出力操作で例外が発生した場合

report

public void report(Stats stats)
            throws IOException
実装は単に、report(Stats, boolean) をリソースをコピーするとして呼出すだけです。

定義:
インタフェース Reporter 内の report
パラメータ:
stats - パフォーマンス統計情報
例外:
IOException - 入出力操作で例外が発生した場合
関連項目:
report(Stats, boolean)

report

public void report(Stats stats,
                   boolean copyResources)
            throws IOException

パフォーマンス統計情報を出力します。

実装は、FreeMarker を使用してテンプレートファイルからレポートを生成します。
テンプレート中で使用可能なオブジェクトの定義を以下に記載します。

パラメータ:
stats - パフォーマンス統計情報
copyResources - 画像やスタイルシートなどのリソースを出力ディレクトへコピーするかどうか
例外:
IOException - 入出力操作で例外が発生した場合

copyResources

protected void copyResources()
                      throws IOException
リソースをコピーします。

例外:
IOException - 入出力例外が発生した場合

marge

protected static void marge(Template template,
                            Map<String,Object> model,
                            String filename)
                     throws IOException,
                            TemplateException
指定されたテンプレートとコンテキストパラメータをマージして指定されたファイルへ保存します。

パラメータ:
template - テンプレート
model - コンテキストパラメータ
filename - 保存するファイル
例外:
IOException
TemplateException

marge

protected static void marge(Template template,
                            Map<String,Object> model,
                            String filename,
                            String encoding)
                     throws IOException,
                            TemplateException
指定されたテンプレートとコンテキストパラメータをマージして指定されたファイルへ保存します。

パラメータ:
template - テンプレート
model - コンテキストパラメータ
filename - 保存するファイル
例外:
IOException
TemplateException


Copyright © 2006-2009 OrangeSignal.com. All Rights Reserved.