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

すべてのスーパーインタフェース:

NodeReferenceResolverFinder, NodeTreeWalker, ParameterAware, PositionAware, SequenceIDGenerator, java.io.Serializable, Specification, TemplateRenderer

public interface Page
extends java.io.Serializable, Specification, TemplateRenderer

テンプレートのレンダリングエントリーポイント。アプリケーションを構成する 各ページのモデルであり、リクエストに対してはステートレスなオブジェクトである。

メソッドの概要

ProcessStatus	doPageRender(java.lang.String requestedSuffix, java.lang.String extension) テンプレートレンダリングを行う。
java.lang.String	getPageName() ページの名前を取得する。
CompiledScript	getSuffixScript() テンプレート接尾辞を決定するコンパイル済みスクリプト。
java.lang.String	getSuperExtension() 継承元テンプレート拡張子の取得。
Page	getSuperPage() 継承元ページの取得。
java.lang.String	getSuperSuffix() 継承元テンプレート接尾辞の取得。
Template	getTemplate(java.lang.String suffix, java.lang.String extension) テンプレート接尾辞より適切なTemplateオブジェクトをロードして返す。
void	initialize(java.lang.String pageName) インスタンスをを初期化する。
boolean	registBeginRenderNotifier(TemplateProcessor processor) トップページの場合に、レンダリング開始時にプロセッサに対して 通知を行うよう登録する。

インタフェース 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.TemplateRenderer から継承されたメソッド

renderTemplate

メソッドの詳細

initialize

void initialize(java.lang.String pageName)

インスタンスをを初期化する。

パラメータ:

pageName - ページ名。

getSuperPage

Page getSuperPage()

継承元ページの取得。

戻り値:

継承元ページもしくはnull。

getSuperSuffix

java.lang.String getSuperSuffix()

継承元テンプレート接尾辞の取得。

戻り値:

テンプレート接尾辞。

getSuperExtension

java.lang.String getSuperExtension()

継承元テンプレート拡張子の取得。

戻り値:

テンプレート拡張子。

getPageName

java.lang.String getPageName()

ページの名前を取得する。/context/hello.htmlであれば、 「/context/hello」を返す。

戻り値:

ページ名。

getSuffixScript

CompiledScript getSuffixScript()

テンプレート接尾辞を決定するコンパイル済みスクリプト。

戻り値:

コンパイル済みスクリプト。

getTemplate

Template getTemplate(java.lang.String suffix,
                     java.lang.String extension)

テンプレート接尾辞より適切なTemplateオブジェクトをロードして返す。

パラメータ:

suffix - テンプレート接尾辞。

extension - テンプレート拡張子。

戻り値:

レンダリングするテンプレート。

doPageRender

ProcessStatus doPageRender(java.lang.String requestedSuffix,
                           java.lang.String extension)

テンプレートレンダリングを行う。

パラメータ:

requestedSuffix - リクエストされたテンプレート接尾辞。

extension - テンプレート拡張子。

戻り値:

プロセッサ処理ステータス。

registBeginRenderNotifier

boolean registBeginRenderNotifier(TemplateProcessor processor)

トップページの場合に、レンダリング開始時にプロセッサに対して 通知を行うよう登録する。

パラメータ:

processor - 通知を受けるプロセッサ。

戻り値:

true=登録成功 / false=既に登録済み