概要 | パッケージ | クラス | 非推奨 API | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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

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

public interface Engine
extends ParameterAware, Specification

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

フィールドの概要

インタフェース org.seasar.mayaa.ParameterAware から継承したフィールド
`IS_SECURE_WEB`

メソッドの概要
`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.ParameterAware から継承したメソッド
`getParameter, iterateParameterNames, setParameter`

インタフェース org.seasar.mayaa.PositionAware から継承したメソッド
`getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID`

インタフェース org.seasar.mayaa.engine.specification.Specification から継承したメソッド
`build, build, getSource, getTimestamp, isDeprecated, setSource`

インタフェース org.seasar.mayaa.engine.specification.NodeTreeWalker から継承したメソッド
`addChildNode, clearChildNodes, getChildNode, getChildNodeSize, getParentNode, insertChildNode, iterateChildNode, kill, removeChildNode, setParentNode`

インタフェース org.seasar.mayaa.engine.specification.serialize.NodeReferenceResolverFinder から継承したメソッド
`findNodeResolver`

インタフェース org.seasar.mayaa.builder.SequenceIDGenerator から継承したメソッド
`nextSequenceID, resetSequenceID`

メソッドの詳細

### setErrorHandler

    public void setErrorHandler(ErrorHandler errorHandler)

  エラーハンドラの設定。

  パラメータ:
    `errorHandler` - エラーハンドラ。

### getErrorHandler

    public ErrorHandler getErrorHandler()

  エラーハンドラの取得。

  戻り値:
    エラーハンドラ。

### findSpecificationFromCache

    public Specification findSpecificationFromCache(java.lang.String systemID)

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

  パラメータ:
    `systemID` - システムID
  戻り値:
    スペック情報インスタンス

### getPage

    public Page getPage(java.lang.String pageName)

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

  パラメータ:
    `pageName` - ページ名。
  戻り値:
    Pageオブジェクト。

### isPageRequested

    public boolean isPageRequested()

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

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

### doService

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

  サービスメソッド。

  パラメータ:
    `pageScopeValues` - PAGEスコープのトップに含めるもの。
    `pageFlush` - テンプレート出力を自動でフラッシュするかどうか。

### handleError

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

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

  パラメータ:
    `t` - 発生した例外。
    `pageFlush` - テンプレート出力を自動でフラッシュするかどうか。

### createPageInstance

    public Page createPageInstance(java.lang.String pageName)

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

  パラメータ:
    `pageName` - ページ名
  戻り値:
    ページ

### createTemplateInstance

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

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

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

### getTemplateID

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

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

  パラメータ:
    `page` - 属するページ
    `suffix` - サフィックス
    `extension` - 拡張子
  戻り値:
    テンプレートのシステムID

### destroy

    public void destroy()

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

概要 | パッケージ | クラス | 非推奨 API | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド