ts.tester.function.print
クラス HtmlPrinterBase

java.lang.Object
  上位を拡張 ts.tester.function.print.AbstractPrinter
      上位を拡張 ts.tester.function.print.HtmlPrinterBase
すべての実装されたインタフェース:
Printer
直系の既知のサブクラス:
HtmlPrinter

public class HtmlPrinterBase
extends AbstractPrinter

試験結果をHTML形式で出力するPrinter クラスの派生クラスである。
試験機能実行クラスの実験結果をHTML形式のファイルに出力する。 出力先のファイル及びHTMLテンプレートは、コンストラクタの引数に指定した リソースファイルの中に記述する。
リソースファイルで指定可能なりソースキーの一覧を下表に示す:

キー 説明
printer.html.toFile 出力先のファイル名
printer.html.format.header 出力されるHTMLテンプレートのヘッダ部
printer.html.format.precases printer.html.format.caseの前に出力されるHTMLテンプレート。
printer.html.format.case 機能試験実行メソッドの数だけ繰り返されるHTMLテンプレート。
printer.html.format.postcases printer.html.format.caseの後に出力されるHTMLテンプレート。
printer.html.format.footer 出力されるHTMLテンプレートのフッタ部。

HTMLテンプレートの構成は、以下の図のようになる。

  printer.html.format.header  
  printer.html.format.precases  
:
  printer.html.format.case  
:
  printer.html.format.postcases  
  printer.html.format.footer  

HTMLテンプレート内で使用できる書式指定子には、以下のものがある:

書式指定子 説明
${test.name} 機能試験名(= 機能試験実行クラス名)
${test.lastname} 機能試験実行クラスの末尾名
${test.package-dir} 機能試験実行クラスのパッケージ・パス
${test.message} 機能試験の説明
${test.tester} 機能試験の実施者名
${test.date[,simple-date-format]} 機能試験の実施日
${test.judge} 機能試験全体の判定結果{"pass"|"reject"}
${test.check} 機能試験全体の判定数
${test.good} 機能試験全体の合格数
${test.nogood} 機能試験全体の不合格数
${test.knownbug} 機能試験全体の既知不具合数
${test.child} 機能試験全体の判定結果数
${test.empty} 機能試験全体の空メソッド数
${test.incomplete} 機能試験全体の実装途中メソッド数
${case.name} 機能試験ケース名(= 機能試験実行メソッド名)
${case.message} 機能試験ケースの説明
${case.judge} 機能試験ケースの判定結果{"pass"|"reject"}
${case.check} 機能試験ケースの判定数
${case.good} 機能試験ケースの合格数
${case.nogood} 機能試験ケースの不合格数
${case.knownbug} 機能試験ケースの既知不具合数
${case.child} 機能試験ケースの下位の判定数
${case.empty} 機能試験ケースの空メソッド数
${case.incomplete} 機能試験ケースの実装途中メソッド数
${case.index} 機能試験ケースのインデックス

バージョン:
$Revision: 1.2 $, $Date: 2007/02/16 16:12:51 $
作成者:
佐藤隆之.

入れ子のクラスの概要
protected  class HtmlPrinterBase._CaseResult
          HtmlPrinterBase用の 試験ケース判定結果クラス。
 
フィールドの概要
protected static java.lang.String EOL
          行末文字。
protected static java.lang.String FMT_CASE
          試験実行メソッドを示す書式指定子。
protected static java.lang.String FMT_TEST
          試験実行クラスを示す書式指定子。
protected static java.lang.String KEY_CASE
          HTMLページの試験ケース部のリソースキー。
protected static java.lang.String KEY_FOOTER
          HTMLページのフッダ部のリソースキー。
protected static java.lang.String KEY_HEADER
          HTMLページのヘッダ部のリソースキー。
protected static java.lang.String KEY_POSTCASES
          HTMLページの試験ケース後部のリソースキー。
protected static java.lang.String KEY_PRECASES
          HTMLページの試験ケース前部のリソースキー。
protected static java.lang.String KEY_TOFILE
          出力するHTMLページのファイル名のリソースキー。
protected static java.lang.String OPT_CHECK
          判定数を示す書式指定子。
protected static java.lang.String OPT_CHILD
          下位の判定数を示す書式指定子。
protected static java.lang.String OPT_DATE
          試験実施日付を示す書式指定子。
protected static java.lang.String OPT_EMPTY
          空メソッド数を示す書式指定子。
protected static java.lang.String OPT_GOOD
          合格数を示す書式指定子。
protected static java.lang.String OPT_INCOMPLETE
          実装途中のメソッド数を示す書式指定子。
protected static java.lang.String OPT_INDEX
          メソッドのインデックスを示す書式指定子。
protected static java.lang.String OPT_JUDGE
          試験結果判定を示す書式指定子。
protected static java.lang.String OPT_KNOWNBUG
          既知不具合数を示す書式指定子。
protected static java.lang.String OPT_LASTNAME
          クラス末尾名を示す書式指定子。
protected static java.lang.String OPT_MESSAGE
          メッセージを示す書式指定子。
protected static java.lang.String OPT_NAME
          名前を示す書式指定子。
protected static java.lang.String OPT_NOGOOD
          不合格数を示す書式指定子。
protected static java.lang.String OPT_PACKAGEDIR
          クラスのパッケージ・パスを示す書式指定子。
protected static java.lang.String OPT_TESTER
          試験実施者を示す書式指定子。
protected static char PREFIX_CHAR
          書式指定子の先頭文字。
 
コンストラクタの概要
protected HtmlPrinterBase()
          デフォルトコンストラクタ。
  HtmlPrinterBase(java.lang.String testerName)
          デフォルトのリソースファイルをロードして、このクラスのインスタンスを作成 するコンストラクタ。
  HtmlPrinterBase(java.lang.String testerName, ts.util.resource.Resource resource)
          試験実施者名とHTMLテンプレートを定義するリソースオブジェクトを引数にとる コンストラクタ。
 
メソッドの概要
 CaseResult createCaseResult(java.lang.String name, CaseResult parent)
          指定された名前の試験ケース判定結果オブジェクトを作成する。
protected  java.lang.String getClassLastName(java.lang.String className)
          クラス名から、その末尾名を抽出する。
protected  java.lang.String getPackageDir(java.lang.String className)
          クラス名から、パッケージ・ディレクトリを求める。
protected  java.lang.String getReplacedString(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> objMap)
          指定された書式文字列内の書式指定子を変換した文字列を返す。
protected  ts.util.resource.Resource getResource()
          HTMLテンプレートを定義したリソースオブジェクトを取得する。
protected  java.lang.String getTesterName()
          試験実施者名を取得する。
protected  void loadDefaultResource()
          デフォルトのリソースファイルをロードする。
protected  void outputHtmlFile(java.util.Map<java.lang.String,java.lang.Object> objMap)
          試験結果をHTMLファイルに出力する。
protected  java.lang.String replaceArgument(java.lang.String arg, java.util.Map<java.lang.String,java.lang.Object> objMap)
          書式指定子を実際の値に変換する。
 void setTesterName(java.lang.String testerName)
          試験実施者の名前を設定する。
 void testEnded(CaseResult root)
          試験全体の終了時に呼び出されるメソッド。
 
クラス ts.tester.function.print.AbstractPrinter から継承されたメソッド
caseEnded, caseStarted, checkOccured, isStopped, messageNoted, setStopped, testStarted, testStopped
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

KEY_TOFILE

protected static final java.lang.String KEY_TOFILE
出力するHTMLページのファイル名のリソースキー。

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

KEY_HEADER

protected static final java.lang.String KEY_HEADER
HTMLページのヘッダ部のリソースキー。

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

KEY_PRECASES

protected static final java.lang.String KEY_PRECASES
HTMLページの試験ケース前部のリソースキー。

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

KEY_CASE

protected static final java.lang.String KEY_CASE
HTMLページの試験ケース部のリソースキー。

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

KEY_POSTCASES

protected static final java.lang.String KEY_POSTCASES
HTMLページの試験ケース後部のリソースキー。

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

KEY_FOOTER

protected static final java.lang.String KEY_FOOTER
HTMLページのフッダ部のリソースキー。

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

PREFIX_CHAR

protected static final char PREFIX_CHAR
書式指定子の先頭文字。

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

EOL

protected static final java.lang.String EOL
行末文字。


FMT_TEST

protected static final java.lang.String FMT_TEST
試験実行クラスを示す書式指定子。

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

FMT_CASE

protected static final java.lang.String FMT_CASE
試験実行メソッドを示す書式指定子。

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

OPT_NAME

protected static final java.lang.String OPT_NAME
名前を示す書式指定子。

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

OPT_LASTNAME

protected static final java.lang.String OPT_LASTNAME
クラス末尾名を示す書式指定子。

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

OPT_PACKAGEDIR

protected static final java.lang.String OPT_PACKAGEDIR
クラスのパッケージ・パスを示す書式指定子。

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

OPT_TESTER

protected static final java.lang.String OPT_TESTER
試験実施者を示す書式指定子。

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

OPT_DATE

protected static final java.lang.String OPT_DATE
試験実施日付を示す書式指定子。

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

OPT_JUDGE

protected static final java.lang.String OPT_JUDGE
試験結果判定を示す書式指定子。

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

OPT_CHECK

protected static final java.lang.String OPT_CHECK
判定数を示す書式指定子。

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

OPT_GOOD

protected static final java.lang.String OPT_GOOD
合格数を示す書式指定子。

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

OPT_NOGOOD

protected static final java.lang.String OPT_NOGOOD
不合格数を示す書式指定子。

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

OPT_KNOWNBUG

protected static final java.lang.String OPT_KNOWNBUG
既知不具合数を示す書式指定子。

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

OPT_CHILD

protected static final java.lang.String OPT_CHILD
下位の判定数を示す書式指定子。

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

OPT_EMPTY

protected static final java.lang.String OPT_EMPTY
空メソッド数を示す書式指定子。

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

OPT_INCOMPLETE

protected static final java.lang.String OPT_INCOMPLETE
実装途中のメソッド数を示す書式指定子。

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

OPT_INDEX

protected static final java.lang.String OPT_INDEX
メソッドのインデックスを示す書式指定子。

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

OPT_MESSAGE

protected static final java.lang.String OPT_MESSAGE
メッセージを示す書式指定子。

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

HtmlPrinterBase

protected HtmlPrinterBase()
デフォルトコンストラクタ。


HtmlPrinterBase

public HtmlPrinterBase(java.lang.String testerName)
デフォルトのリソースファイルをロードして、このクラスのインスタンスを作成 するコンストラクタ。

パラメータ:
testerName - 試験実施者名。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードの場合)。

HtmlPrinterBase

public HtmlPrinterBase(java.lang.String testerName,
                       ts.util.resource.Resource resource)
試験実施者名とHTMLテンプレートを定義するリソースオブジェクトを引数にとる コンストラクタ。

パラメータ:
testerName - 試験実施者名。
resource - HTMLテンプレートを定義するリソースオブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードの場合)。
メソッドの詳細

loadDefaultResource

protected void loadDefaultResource()
デフォルトのリソースファイルをロードする。


getResource

protected ts.util.resource.Resource getResource()
HTMLテンプレートを定義したリソースオブジェクトを取得する。

戻り値:
リソースオブジェクト。

setTesterName

public void setTesterName(java.lang.String testerName)
試験実施者の名前を設定する。

パラメータ:
testerName - 試験実施者。
例外:
AssertError - 引数がヌルの場合。

getTesterName

protected java.lang.String getTesterName()
試験実施者名を取得する。

戻り値:
試験実施者名。

createCaseResult

public CaseResult createCaseResult(java.lang.String name,
                                   CaseResult parent)
指定された名前の試験ケース判定結果オブジェクトを作成する。

パラメータ:
name - 試験ケース名。
parent - 親の試験ケース判定結果オブジェクト。
戻り値:
試験ケース判定結果オブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードの場合)。

testEnded

public void testEnded(CaseResult root)
試験全体の終了時に呼び出されるメソッド。

定義:
インタフェース Printer 内の testEnded
オーバーライド:
クラス AbstractPrinter 内の testEnded
パラメータ:
root - 最上位の試験ケース判定結果オブジェクト。
例外:
java.lang.AssertionError - 引数がヌル又は不正な場合(デバッグモードの場合)。

outputHtmlFile

protected void outputHtmlFile(java.util.Map<java.lang.String,java.lang.Object> objMap)
試験結果をHTMLファイルに出力する。
書式指定子を置き換える値オブジェクトをマップに格納して、 getReplacedStringに渡している。

パラメータ:
objMap - 書式指定子を置き換える値を格納したマップ。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードの場合)。

getReplacedString

protected java.lang.String getReplacedString(java.lang.String key,
                                             java.util.Map<java.lang.String,java.lang.Object> objMap)
指定された書式文字列内の書式指定子を変換した文字列を返す。

パラメータ:
key - 書式文字列のキー。
objMap - 書式指定子を置き換える値を格納したマップ。
戻り値:
変換後の文字列。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

replaceArgument

protected java.lang.String replaceArgument(java.lang.String arg,
                                           java.util.Map<java.lang.String,java.lang.Object> objMap)
書式指定子を実際の値に変換する。
書式指定子を置き換える値オブジェクトは、引数のマップに対して以下の 書式指定子を指定することによって取り出すことができる。
FMT_TEST 試験実行クラスに対する_CaseResult オブジェクト。
FMT_CASE 試験実行メソッドに対するHtmlPrinterBase._CaseResultオブジェクト

パラメータ:
arg - 書式指定子。
objMap - 書式指定子を置き換える値を格納したマップ。
戻り値:
変換後の文字列。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getPackageDir

protected java.lang.String getPackageDir(java.lang.String className)
クラス名から、パッケージ・ディレクトリを求める。

パラメータ:
className - クラス名。
戻り値:
クラスのパッケージ・ディレクトリ。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getClassLastName

protected java.lang.String getClassLastName(java.lang.String className)
クラス名から、その末尾名を抽出する。

パラメータ:
className - クラス名。
戻り値:
クラスの末尾名。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。


Copyright (C) SATOH Takayuki All Rights Reserved.