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

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

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

public interface Engine
extends ParameterAware, Specification

ランタイムエンジン。ホストサーブレットからservice()が呼び出される。 リクエストに対して、ステートレスに実装。

メソッドの概要

Page	createPageInstance(java.lang.String pageName) ページのインスタンスを生成しソースビルドを行ってから返す。
Template	createTemplateInstance(Page page, java.lang.String suffix, java.lang.String extension) テンプレートのインスタンスを生成しソースビルドを行ってから返す。
void	destroy() Engineを破棄します。
void	doService(java.util.Map pageScopeValues, boolean pageFlush) サービスメソッド。
Specification	findSpecificationFromCache(java.lang.String systemID) ページやテンプレートなどのスペック情報のインスタンスが メモリキャッシュに存在する場合は返却する。
ErrorHandler	getErrorHandler() エラーハンドラの取得。
Page	getPage(java.lang.String pageName) Pageオブジェクトのインスタンスを返す。
java.lang.String	getTemplateID(Page page, java.lang.String suffix, java.lang.String extension) テンプレートの示すシステムIDを返す。
void	handleError(java.lang.Throwable t, boolean pageFlush) エラーハンドルページの表示。
boolean	isPageRequested() レンダリング可能なページを示すリクエストかどうかを判定する。
void	setErrorHandler(ErrorHandler errorHandler) エラーハンドラの設定。

インタフェース org.seasar.mayaa.PositionAware から継承されたメソッド

getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID

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

getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID

メソッドの詳細

setErrorHandler

void setErrorHandler(ErrorHandler errorHandler)

エラーハンドラの設定。

パラメータ:

errorHandler - エラーハンドラ。

getErrorHandler

ErrorHandler getErrorHandler()

エラーハンドラの取得。

戻り値:

エラーハンドラ。

findSpecificationFromCache

Specification findSpecificationFromCache(java.lang.String systemID)

ページやテンプレートなどのスペック情報のインスタンスが メモリキャッシュに存在する場合は返却する。

パラメータ:

systemID - システムID

戻り値:

スペック情報インスタンス

getPage

Page getPage(java.lang.String pageName)

Pageオブジェクトのインスタンスを返す。

パラメータ:

pageName - ページ名。

戻り値:

Pageオブジェクト。

isPageRequested

boolean isPageRequested()

レンダリング可能なページを示すリクエストかどうかを判定する。

戻り値:

mayaaがレンダリング対象とする場合はtrue

doService

void doService(java.util.Map pageScopeValues,
               boolean pageFlush)

サービスメソッド。

パラメータ:

pageScopeValues - PAGEスコープのトップに含めるもの。

pageFlush - テンプレート出力を自動でフラッシュするかどうか。

handleError

void handleError(java.lang.Throwable t,
                 boolean pageFlush)

エラーハンドルページの表示。

パラメータ:

t - 発生した例外。

pageFlush - テンプレート出力を自動でフラッシュするかどうか。

createPageInstance

Page createPageInstance(java.lang.String pageName)

ページのインスタンスを生成しソースビルドを行ってから返す。

パラメータ:

pageName - ページ名

戻り値:

ページ

createTemplateInstance

Template createTemplateInstance(Page page,
                                java.lang.String suffix,
                                java.lang.String extension)

テンプレートのインスタンスを生成しソースビルドを行ってから返す。

パラメータ:

page - ページ

suffix - テンプレートの接尾子。

extension - ページの拡張子。

戻り値:

テンプレート

getTemplateID

java.lang.String getTemplateID(Page page,
                               java.lang.String suffix,
                               java.lang.String extension)

テンプレートの示すシステムIDを返す。

パラメータ:

page - 属するページ

suffix - サフィックス

extension - 拡張子

戻り値:

テンプレートのシステムID

destroy

void destroy()

Engineを破棄します。 destroy()が呼ばれた後のEngineの動作は保証されません。