org.seasar.mayaa.engine
インタフェース Template

すべてのスーパーインタフェース:
NodeReferenceResolverFinder, NodeTreeWalker, ParameterAware, PositionAware, ProcessorReferenceResolverFinder, ProcessorTreeWalker, SequenceIDGenerator, java.io.Serializable, Specification

public interface Template
extends Specification, ProcessorTreeWalker, java.io.Serializable

テンプレートオブジェクト。HTMLをパースした結果の、 TemplateProcessorのツリー構造を内包。 リクエストに対して、ステートレスである。 シリアライズ可能。


メソッドの概要
 ProcessStatus doTemplateRender(Page topLevelPage)
          テンプレートをレンダリングする。
 java.lang.String getExtension()
          ページの拡張子を返す。
 Page getPage()
          ページへの参照を取得する。
 java.lang.String getSuffix()
          テンプレートの接尾子を返す。
 void initialize(Page page, java.lang.String suffix, java.lang.String extension)
          テンプレートを初期化する。
 
インタフェース org.seasar.mayaa.engine.specification.Specification から継承されたメソッド
build, getSource, getTimestamp, isDeprecated, setSource
 
インタフェース org.seasar.mayaa.engine.specification.NodeTreeWalker から継承されたメソッド
addChildNode, clearChildNodes, getChildNode, getChildNodeSize, getParentNode, insertChildNode, iterateChildNode, kill, removeChildNode, setParentNode
 
インタフェース org.seasar.mayaa.PositionAware から継承されたメソッド
getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID
 
インタフェース org.seasar.mayaa.engine.specification.serialize.NodeReferenceResolverFinder から継承されたメソッド
findNodeResolver
 
インタフェース org.seasar.mayaa.builder.SequenceIDGenerator から継承されたメソッド
nextSequenceID, resetSequenceID
 
インタフェース org.seasar.mayaa.ParameterAware から継承されたメソッド
getParameter, iterateParameterNames, setParameter
 
インタフェース org.seasar.mayaa.PositionAware から継承されたメソッド
getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID
 
インタフェース org.seasar.mayaa.engine.processor.ProcessorTreeWalker から継承されたメソッド
addChildProcessor, clearChildProcessors, getChildProcessor, getChildProcessorSize, getParentProcessor, getVariables, insertProcessor, removeProcessor, setParentProcessor
 
インタフェース org.seasar.mayaa.engine.specification.serialize.ProcessorReferenceResolverFinder から継承されたメソッド
findProcessorResolver
 

メソッドの詳細

initialize

void initialize(Page page,
                java.lang.String suffix,
                java.lang.String extension)
テンプレートを初期化する。

パラメータ:
page - ページ。
suffix - テンプレートの接尾子。
extension - ページの拡張子。

getPage

Page getPage()
ページへの参照を取得する。

戻り値:
ページ。

getSuffix

java.lang.String getSuffix()
テンプレートの接尾子を返す。hello_ja.htmlであれば、「ja」を返す。 hello.htmlでは空白文字列。

戻り値:
テンプレートの接尾子。

getExtension

java.lang.String getExtension()
ページの拡張子を返す。/context/hello.htmlだと、「html」。ドットを含まない。

戻り値:
ページの拡張子。

doTemplateRender

ProcessStatus doTemplateRender(Page topLevelPage)
テンプレートをレンダリングする。

パラメータ:
topLevelPage - 描画トップレベルのページ。
戻り値:
テンプレートプロセッサのプロセスステートフラグ。