The Seasar Foundation Project Site

要素クラスの作成

インタフェース「TemplateElement」を継承してクラスを実装します。「merge」メソッドを実装する必要があります。また、必要に応じてコンストラクタを定義します。

public class Sample implements TemplateElement{
    private HSSFCell originalCell;

    public Sample(HSSFCell cell){
        originalCell = cell;
    }

    public void merge(FPContext context) throws FPMergeException {
        HSSFCell currentCell = context.getCurrentCell();
        currentCell.setCellStyle(originalCell.getCellStyle());
        currentCell.setCellValue(new HSSFRichTextString("独自タグテストです"));
        context.nextRow();
    }

}

コンストラクタで、「#sample」と書かれているセルそのものを受け取ります。 それを originalCell というメンバ変数に保持しておきます。

merge メソッドは、TemplateElement インタフェースに定義されているメソッドです。 これが実際にデータ埋め込み時に呼ばれます。引数はデータ埋め込み時にグローバルで管理する各変数を保持している FPContext クラスです。 ここから埋め込みデータやら現在位置やらを取得します。

ここでは、現在処理中のセルをHSSFCellとして取得します。 そこへ、originalCellからスタイルを取得して現在処理中のセルにコピーしています。 そしてそのセルに「独自タグテストです」という文字列をセットしています。

これでA列に「独自タグテストです」が入ったので、FPContext#nextRow() を呼び出して、 FPContext に「処理を次の行に移してくれ」と命令します。

パーサクラスの作成

次に、このタグを解析して上の Sample クラスを生成するパーサを作ります。RowParser インタフェースを実装します。

public class SampleParser implements RowParser{
    public boolean process(CellWrapper cell, FPParser parser)  throws FPParseException {
        String value =cell.getStringValue();
        if(!"#sample".equals(value)){
            return false;
        }
        TemplateElement elem = new Sample(cell.getHSSFCell());
        parser.addTemplateElement(elem);
        return true;
    }
}

RowParserインタフェースのprocessメソッドを実装します。 この最中に何かエラーが起きた場合は、FPParserExceptionを投げるようにします。

パース時に見るセル（その行のA列）である CellWrapper と、大元のパーサである FPParser が引数で渡って来ます。 CellWrapperは、POI のクラスである HSSFCell を、Fisshplate が解析しやすいようにラップしたクラスです。

セルの値を文字列として取得します。RowParserr#process が FPParser から呼ばれた時点でセルの値は必ず文字列である事が保証されています。

その値が「#sample」じゃなかったらパース対象でないので false を戻します。 「#sample」ならば、Sample クラスを生成して、FPParser#addTemplateElement の引数にセットし、 要素として登録します。

動かしてみる

データを埋め込む際に、このパーサクラスを、FPTemplate に追加します。

InputStream is = getClass().getResourceAsStream("/Template.xls");

template = new FPTemplate();
template.addRowParser(new SampleParser()); //SampleParserの登録

Map map = new HashMap();
//
//ここで、mapに対して実際のデータをセットしたりする。
//
HSSFWorkbook wb = template.process(is, map);
is.close();
FileOutputStream fos = new FileOutputStream("out.xls");
wb.write(fos);
fos.close();

上記コードでは、try catchなどは省略してます。これで、A列に「#sample」という値があった場合、その行のA列に「独自タグテストです」と入力されているはずです。

ブロック要素の場合

例えば、「#sample」で始まり、「#end」で終了し、その間にある行を子要素として持つものをブロック要素とします。

独自のブロック要素を作る場合は、他にもルールがあります。

public class Sample extends AbstractBlock{
    private HSSFCell originalCell;

    public Sample(HSSFCell cell){
        originalCell = cell;
    }

    public void merge(FPContext context) throws FPMergeException {
        HSSFCell currentCell = context.getCurrentCell();
        currentCell.setCellStyle(originalCell.getCellStyle());
        currentCell.setCellValue(new HSSFRichTextString("独自タグテストです"));
        context.nextRow();

        mergeChildren(context);

    }
}

public class SampleParser implements RowParser{
    public boolean process(CellWrapper cell, FPParser parser)  throws FPParseException {
        String value =cell.getStringValue();
        if(!"#sample".equals(value)){
            return false;
        }
        AbstractBlock elem = new Sample(cell.getHSSFCell());
        parser.addBlockElement(block);
        return true;
    }
}