Name
Password

ZPTテンプレート

  • 2008-07-17 14:43:56

Ymirでの標準のビューテンプレート記述言語はZPT（Zope Page Template）です。ZPTエンジンとしてSkirnirプロジェクトから公開されているタグベーステンプレートエンジン構築フレームワークFreyja（フレイヤ）に含まれているZPT実装（以下単にFreyjaと呼びます）を使っています。

Freyjaは基本的にオリジナルのZPTの仕様に従っていますが、いくつかの違いがあります。ここでは、主にオリジナルの仕様との相違点について説明します。

オリジナルのZPT仕様の詳細についてはZPTのサイトにある

を参照して下さい。

オリジナルとの相違点

ZPT全般

  • 式の評価結果の真偽判定においては、以下のいずれかに合致した場合に偽とみなします。それ以外は真とみなします。
    • 評価対象が変数であるが値が存在しない
    • nullである
    • java.lang.BooleanインスタンスでかつFALSEと同値である
    • java.lang.Numberインスタンスでかつ値が0である
    • 配列でかつ長さが0である
    • java.util.Collectionインスタンスでかつ空である
    • java.util.Enumerationインスタンスでかつ残りの要素がない
    • java.util.Iteratorインスタンスでかつ残りの要素がない
    • toString()の値の長さが0である

TAL

  • 名前空間はサポートしていません。指定しても無視されます。
  • tal:on-errorで利用できるエラーオブジェクトが異なります。Freyjaでは以下のオブジェクトが利用可能です。
    type: 発生したjava.lang.Throwableのクラス名
    value: 発生したjava.lang.Throwableオブジェクト
    traceback: スタックトレース文字列
  • [Freyja拡張] tal:contentで空文字列を式として与えた場合は偽と評価されます。
  • tal:repeatでは、式の評価結果が配列またはjava.util.Collectionである場合はそれらの持つ要素について処理が繰り返されます。nullまたは値が存在しない場合は一度も繰り返されません。それ以外の場合は評価結果自身について一度だけ処理が行なわれます。
  • tal:repeatで繰り返し変数のプロパティ「Letter」は「LETTER」と表記する必要があります。また、以下のプロパティは未サポートです。
    • roman
    • Roman

TALES

  • 次の変数が組み込み変数として用意されています。

    名前 値
    nothing null
    null null
    default net.skirnir.freyja.zpt.DefaultクラスのSingletonオブジェクト
    CONTEXTS グローバル変数が格納されたjava.util.Mapオブジェクト
    true java.lang.Boolean.TRUE
    false java.lang.Boolean.FALSE
    request javax.servlet.http.HttpServletRequestオブジェクト
    response javax.servlet.http.HttpServletResponseオブジェクト
    session javax.servlet.http.HttpSessionオブジェクト。セッションが生成されていない場合は未定義
    application javax.servlet.ServletContextオブジェクト
    locale リクエストを処理する際のLocaleオブジェクト
    ymirRequest [Ymir拡張] org.seasar.ymir.Requestオブジェクト
    container [Ymir拡張] org.seasar.framework.container.S2Containerオブジェクト
    messages [Ymir拡張] メッセージリソースが格納されているorg.seasar.ymir.Messagesオブジェクト
    token [Ymir拡張] トランザクショントークンを扱うためのorg.seasar.ymir.Tokenオブジェクト。詳しい使い方については「トランザクショントークン」を参照のこと

    また変数ではありませんが負でない整数を書いた場合、その数値を表すjava.lang.Integerのオブジェクトとみなされます。

    以下の変数は未サポートです。

    • options
    • attrs
    • root
    • here
    • container
    • template
    • user
    • modules
  • [Freyja拡張] 複数のセグメントからなるPath式を評価する時、セグメントの評価値が偽である場合は次のセグメントを評価しますが、セグメントの区切り記号として「||」を使用すると、セグメントの評価値がnullのときのみ次のセグメントを評価します。
  • Nocall式は式の値を加工しません。「nocall:」をつけない場合と同じ挙動をします。
  • Python式はサポートしていません。
  • [Freyja拡張] Java式をサポートしています。具体的には、「java:」をつけることでJavaの式を記述することができます（Tigerの記法には対応していません）。
  • [Freyja拡張] Page式をサポートしています。「page:<コンテキストパス相対のURI>」という式を、URIにコンテキストパスを補完して必要に応じてセッションIDを付加したURLに変換します。URIにはリクエストパラメータを付与することもできます。また、URIの途中やリクエストパラメータの中にString式のような$...という置換指定を記述することもできます。リクエストパラメータの中に記述された置換指定は、値をURLエンコードした上で埋め込まれます。
  • [Freyja拡張] Include式をサポートしています。「include:<コンテキストパス相対のURI>」という式を、指定されたURIが指すページの内容に置き換えます。これはJSPの<jsp:include>に相当します。
  • [Freyja拡張] IncludeBody式をサポートしています。「include-body:<コンテキストパス相対のURI>」という式を、指定されたURIが指すページの<body>タグの内容（<body>タグ自身は含みません）に置き換えます。
  • [Freyja拡張] I18npage式をサポートしています。「i18npage:<コンテキストパス相対のURI>」と記述します。URIの拡張子の前に、現在のロケールから決定された（Javaのプロパティファイル形式の）接尾辞を付加する以外はPage式と同じです。接尾辞は現在のロケールと同一になるのではなく、URI＋ロケールに対応するリソースが存在するものに変換されることに注意して下さい。例えば/image/title_ja.jpgが存在して/image/title_ja_JP.jpgが存在しない場合、ロケールが「ja_JP」であっても最終的なURIは/image/title_ja.jpgになります。

TALESのPath式

ここではFreyjaにおけるTALESのPath式の扱いに関して説明します。

最初のセグメントの解決手順

Path式の最初のセグメント（「first/second/third」の「first」の部分）は次の順序に従って解決されます。

  1. 組み込み変数であれば変数の値。
  2. HttpServletRequest#getAttribute("first")の値がnullでなければその値。
  3. セッションが張られていてかつHttpSession#getAttribute("first")の値がnullでなければその値。
  4. ServletContext#getAttribute("first")の値がnullでなければその値。
  5. HttpServletRequest#getParameter("first")の値がnullでなければその値。
  6. [Ymir拡張] 処理対象のPageオブジェクトが存在してかつPage#getFirst()メソッドまたはPage#isFirst()が存在し、メソッドの返り値がnullでなければその値。
  7. 上記のいずれにも該当しない場合はnull。

セグメントの解釈

例えばPath式で「self/name」と書いた場合、selfを解決した結果であるオブジェクトについてセグメント「name」を解釈した結果が最終結果になります。

セグメントは基本的にはオブジェクトのプロパティと解釈されます。したがって、例えば上記の例ではselfに対応するオブジェクトについてgetName()メソッドを呼び出した結果が最終結果になります。

オブジェクトの型によっては以下のような特別な解釈がなされます。解釈は以下の表の上から順に適用され、結果がnullでExceptionがスローされなければさらに下の解釈が適用されます。

オブジェクトの型 解釈
org.seasar.ymir.Messages

[Ymir拡張] セグメントが「%」で始まる場合、「%」を除いた文字列を引数としてgetMessage()を呼び出した結果。そうでない場合はセグメント文字列を引数としてロケールなしでgetProperty()を呼び出した結果。

結果がnullである場合はMessageNotFoundRuntimeExceptionがスローされる。
org.seasar.kvasir.util.collection.I18NPropertyReader [Ymir拡張] セグメントが「%」で始まる場合、「%」を除いた文字列を引数として現在のロケールについてgetProperty()を呼び出した結果。そうでない場合はセグメント文字列を引数としてロケールなしでgetProperty()を呼び出した結果。
org.seasar.kvasir.util.collection.PropertyReader [Ymir拡張] セグメント文字列を引数としてgetProperty()を呼び出した結果。
org.seasar.kvasir.util.collection.AttributeReader [Ymir拡張] セグメント文字列を引数としてgetAttribute()を呼び出した結果。
org.seasar.ymir.Notes [Ymir拡張] セグメントが「size」である場合、Notes#size()の結果。「size(XXX)」の形である場合、「XXX」の部分の文字列を引数としてNotes#size(String)を呼び出した結果。「categories」である場合、Notes#categories()の結果。それ以外の場合、セグメント文字列をNotesのカテゴリ文字列とみなして、そのカテゴリに属するNoteが存在するならNotes#get(カテゴリ文字列)の返り値。
org.seasar.ymir.Note [Ymir拡張] セグメントが「%value」である場合、Note#getValue()の返り値をキーとして現在のロケールについてメッセージリソースを検索した結果のメッセージ文字列。メッセージ文字列が見つからなかった場合はMessageNotFoundRuntimeExceptionがスローされる。
java.util.Collection セグメントが「size」である場合、Collection#size()の結果。
配列型 セグメントが「length」である場合、配列の長さ。
java.lang.String セグメントが「length」である場合、文字列の長さ。
java.util.Date セグメント文字列中の「%」を「/」に置き換えたものをフォーマット文字列として日時を現在のロケールに従ってフォーマットした結果。例えばオブジェクトの表す日時が1983年1月14日でセグメント文字列が「yyyy%MM%dd」である場合、結果は「1983/01/14」となる。
全ての型 セグメント文字列をオブジェクトのプロパティ名とみなす。オブジェクトのプロパティの値が結果となる。該当するプロパティが存在しない場合はnull。

特別なrequestスコープオブジェクト

Ymirでは以下のオブジェクトがrequestスコープにバインドされています。

名前 値
self 処理対象のPageオブジェクト。リクエストパスに対応するPageコンポーネントが存在しない場合は未定義
notes 制約違反のメッセージを保持するorg.seasar.ymir.Notesオブジェクト。制約違反でない場合は未定義

したがって、例えばPageオブジェクトのtitleプロパティの値を参照したい場合は「self/title」と書けばよいことになります。