org.seasar.fisshplate.context
クラス FPContext

java.lang.Object
  上位を拡張 org.seasar.fisshplate.context.FPContext

public class FPContext
extends Object

解析やデータ埋め込み時に参照される、グローバル値を保持するクラスです。

作成者:
rokugen, a-conv

コンストラクタの概要
FPContext(HSSFSheet out, Map data)
          コンストラクタです。
 
メソッドの概要
 void addSuspendedSet(Suspend suspend)
          評価を保留するセルを保留リストに追加します。
 void clearCurrentIterator()
          現在のIteratorBlockを消去します。
 HSSFRow createCurrentRow()
          現在の出力対象行を新たに生成します。
 HSSFCell getCurrentCell()
          現在の出力対象セルを戻します。
 int getCurrentCellNum()
          現在のセルの位置を戻します。
 IteratorBlock getCurrentIterator()
          現在のIteratorBlockを戻します。
 HSSFRow getCurrentRow()
          現在の出力対象行を戻します。
 int getCurrentRowNum()
          現在の行の位置を戻します。
 Map getData()
          埋め込むデータを戻します。
 HSSFSheet getOutSheet()
          出力するシートを戻します。
 HSSFPatriarch getPartriarch()
           
 Set getSuspendedSet()
          保留リストを戻します。
 void init()
          現在の出力対象位置を初期化します。
 boolean inIteratorBlock()
          現在、IteratorBlockの中に居るか否かを戻します。
 boolean isSkipMerge()
           
 HSSFCell moveCurrentCellTo(int cellNum)
          現在の出力対象セルを任意の場所に移動し、そのセルを戻します。
 HSSFRow moveCurrentRowTo(int rowNum)
          現在の出力対象行を任意の場所に移動し、その行を戻します。
 void nextCell()
          出力対象セルを次のセルに進めます。
 void nextRow()
          出力対象行を次の行に進めます。
 void setCurrentIterator(IteratorBlock currentIterator)
          現在のIteratorBlockを設定します。
 void setShouldFooterOut(boolean should)
           
 void setShouldHeaderOut(boolean should)
           
 void setSkipMerge(boolean skipMerge)
           
 boolean shouldFooterOut()
           
 boolean shouldHeaderOut()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FPContext

public FPContext(HSSFSheet out,
                 Map data)
コンストラクタです。

パラメータ:
out - 出力するシート
data - 埋め込むデータ
メソッドの詳細

init

public void init()
現在の出力対象位置を初期化します。


nextRow

public void nextRow()
出力対象行を次の行に進めます。


nextCell

public void nextCell()
出力対象セルを次のセルに進めます。


getData

public Map getData()
埋め込むデータを戻します。

戻り値:
埋め込みデータ

getCurrentRow

public HSSFRow getCurrentRow()
現在の出力対象行を戻します。 まだ無ければ生成します。

戻り値:
出力対象行

createCurrentRow

public HSSFRow createCurrentRow()
現在の出力対象行を新たに生成します。

戻り値:

moveCurrentRowTo

public HSSFRow moveCurrentRowTo(int rowNum)
現在の出力対象行を任意の場所に移動し、その行を戻します。

パラメータ:
rowNum - 移動先の行番号
戻り値:
出力対象行

getCurrentCell

public HSSFCell getCurrentCell()
現在の出力対象セルを戻します。

戻り値:
出力対象セル

moveCurrentCellTo

public HSSFCell moveCurrentCellTo(int cellNum)
現在の出力対象セルを任意の場所に移動し、そのセルを戻します。

パラメータ:
cellNum - 移動先のセル番号
戻り値:
出力対象セル

getCurrentRowNum

public int getCurrentRowNum()
現在の行の位置を戻します。

戻り値:
行の位置(0スタート)

getCurrentCellNum

public int getCurrentCellNum()
現在のセルの位置を戻します。

戻り値:
セルの位置(0スタート)

getOutSheet

public HSSFSheet getOutSheet()
出力するシートを戻します。

戻り値:
シート

shouldHeaderOut

public boolean shouldHeaderOut()

setShouldHeaderOut

public void setShouldHeaderOut(boolean should)

shouldFooterOut

public boolean shouldFooterOut()

setShouldFooterOut

public void setShouldFooterOut(boolean should)

isSkipMerge

public boolean isSkipMerge()

setSkipMerge

public void setSkipMerge(boolean skipMerge)

getPartriarch

public HSSFPatriarch getPartriarch()

getCurrentIterator

public IteratorBlock getCurrentIterator()
現在のIteratorBlockを戻します。

戻り値:
現在のIteratorBlock

setCurrentIterator

public void setCurrentIterator(IteratorBlock currentIterator)
現在のIteratorBlockを設定します。

パラメータ:
currentIterator - 現在のIteratorBlock

clearCurrentIterator

public void clearCurrentIterator()
現在のIteratorBlockを消去します。


inIteratorBlock

public boolean inIteratorBlock()
現在、IteratorBlockの中に居るか否かを戻します。

戻り値:
IteratorBlockの中に居ればtrue。

addSuspendedSet

public void addSuspendedSet(Suspend suspend)
評価を保留するセルを保留リストに追加します。

パラメータ:
suspend - 評価を保留するセル

getSuspendedSet

public Set getSuspendedSet()
保留リストを戻します。

戻り値:
保留リスト


Copyright © 2009 The Seasar Foundation. All Rights Reserved.