JDomXMLMailBuilder (ozacc-mail library 1.1.3 API)
Keywords: com.ozacc.mail.impl.JDomXMLMailBuilder class

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

## com.ozacc.mail.impl
クラス JDomXMLMailBuilder

    java.lang.Object
      com.ozacc.mail.impl.JDomXMLMailBuilder

すべての実装インタフェース:
  MailBuilder, VelocityMailBuilder

public class JDomXMLMailBuilder
extends Object
implements VelocityMailBuilder

JDOMを利用してXMLファイルからMailインスタンスを生成するクラス。

ソースXMLを読み込む際に、DTDバリデーションが実行されますので妥当なXMLデータ(Valid XML Document)でなければいけません。

導入されたバージョン:
  1.0
バージョン:
  $Id: JDomXMLMailBuilder.java,v 1.12 2004/11/03 06:59:36 otsuka Exp $
作成者:
  Tomohiro Otsuka

フィールドの概要
`protected Map` | `templateCache`
`protected LogSystem` | `velocityLogSystem`

コンストラクタの概要
`JDomXMLMailBuilder()` コンストラクタ。

メソッドの概要
`protected Mail` | `build(Document doc)` XMLドキュメントからMailインスタンスを生成します。
`protected Mail` | `build(String templateText, VelocityContext context)` VelocityContextとXMLドキュメントをマージさせ、Mailインスタンスを生成します。
`Mail` | `buildMail(File file)` 指定されたXMLファイルからMailインスタンスを生成します。
`Mail` | `buildMail(File file, VelocityContext context)` 指定されたXMLファイルからMailインスタンスを生成します。
`Mail` | `buildMail(String classPath)` 指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。
`Mail` | `buildMail(String classPath, VelocityContext context)` 指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。
`void` | `clearCache()` メールデータキャッシュをクリアします。
`protected Document` | `getDocumentFromClassPath(String classPath)` 指定されたクラスパス上のファイルを読み込んで、XMLドキュメントを生成します。
`protected Document` | `getDocumentFromFile(File file)` 指定されたファイルを読み込んで、XMLドキュメントを生成します。
`protected String` | `getTemplateCache(String key)`
`protected boolean` | `hasTemplateCache(String key)`
`boolean` | `isCacheEnabled()` VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。
`protected void` | `putTemplateCache(String key, String templateXmlText)`
`protected void` | `setBody(Element root, Mail mail)`
`void` | `setCacheEnabled(boolean cacheEnabled)` VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。
`protected void` | `setFrom(Element root, Mail mail)`
`protected void` | `setHtml(Element root, Mail mail)`
`protected void` | `setRecipients(Element root, Mail mail)`
`protected void` | `setReplyTo(Element root, Mail mail)`
`protected void` | `setReturnPath(Element root, Mail mail)`
`protected void` | `setSubject(Element root, Mail mail)`

クラス java.lang.Object から継承したメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### velocityLogSystem

    protected LogSystem velocityLogSystem

### templateCache

    protected Map templateCache

コンストラクタの詳細

### JDomXMLMailBuilder

    public JDomXMLMailBuilder()

  コンストラクタ。

メソッドの詳細

### buildMail

    public Mail buildMail(String classPath)
                   throws MailBuildException

  指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。

  定義:
    インタフェース `MailBuilder` 内の `buildMail`
  パラメータ:
    `classPath` - メール内容を記述したXMLファイルのパス
  戻り値:
    生成されたMailインスタンス
  例外:
    `MailBuildException` - Mailインスタンスの生成に失敗した場合

### buildMail

    public Mail buildMail(String classPath,
                          VelocityContext context)
                   throws MailBuildException

  指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。

  定義:
    インタフェース `VelocityMailBuilder` 内の `buildMail`
  パラメータ:
    `classPath` - メール内容を記述したXMLファイルのパス
    `context` - VelocityContext
  戻り値:
    生成されたMailインスタンス
  例外:
    `MailBuildException` - Mailインスタンスの生成に失敗した場合

### buildMail

    public Mail buildMail(File file)
                   throws MailBuildException

  指定されたXMLファイルからMailインスタンスを生成します。

  定義:
    インタフェース `MailBuilder` 内の `buildMail`
  パラメータ:
    `file` - メール内容を記述したXMLファイル
  戻り値:
    生成されたMailインスタンス
  例外:
    `MailBuildException` - Mailインスタンスの生成に失敗した場合

### buildMail

    public Mail buildMail(File file,
                          VelocityContext context)
                   throws MailBuildException

  指定されたXMLファイルからMailインスタンスを生成します。 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。

  定義:
    インタフェース `VelocityMailBuilder` 内の `buildMail`
  パラメータ:
    `file` - メール内容を記述したXMLファイル
    `context` - VelocityContext
  戻り値:
    生成されたMailインスタンス
  例外:
    `MailBuildException` - Mailインスタンスの生成に失敗した場合

### getDocumentFromClassPath

    protected Document getDocumentFromClassPath(String classPath)
                                         throws MailBuildException

  指定されたクラスパス上のファイルを読み込んで、XMLドキュメントを生成します。

  パラメータ:
    `classPath` -
  戻り値:
    JDOM Document
  例外:
    `MailBuildException`

### getDocumentFromFile

    protected Document getDocumentFromFile(File file)

  指定されたファイルを読み込んで、XMLドキュメントを生成します。

  パラメータ:
    `file` -
  戻り値:
    JDOM Document

### build

    protected Mail build(Document doc)

  XMLドキュメントからMailインスタンスを生成します。

  パラメータ:
    `doc` -
  戻り値:
    Mail

### build

    protected Mail build(String templateText,
                         VelocityContext context)
                  throws Exception,
                         ParseErrorException,
                         MethodInvocationException,
                         ResourceNotFoundException,
                         IOException,
                         JDOMException

  VelocityContextとXMLドキュメントをマージさせ、Mailインスタンスを生成します。

  パラメータ:
    `context` -
  戻り値:
    Mail
  例外:
    `Exception`
    `ParseErrorException`
    `MethodInvocationException`
    `ResourceNotFoundException`
    `IOException`
    `JDOMException`

### setReturnPath

    protected void setReturnPath(Element root,
                                 Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setReplyTo

    protected void setReplyTo(Element root,
                              Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setBody

    protected void setBody(Element root,
                           Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setHtml

    protected void setHtml(Element root,
                           Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setSubject

    protected void setSubject(Element root,
                              Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setRecipients

    protected void setRecipients(Element root,
                                 Mail mail)

  パラメータ:
    `root` -
    `mail` -

### setFrom

    protected void setFrom(Element root,
                           Mail mail)

  パラメータ:
    `root` -
    `mail` -

### clearCache

    public void clearCache()

  インタフェース `VelocityMailBuilder` の記述:
  メールデータキャッシュをクリアします。

  定義:
    インタフェース `VelocityMailBuilder` 内の `clearCache`
  関連項目:
    `VelocityMailBuilder.clearCache()`

### isCacheEnabled

    public boolean isCacheEnabled()

  インタフェース `VelocityMailBuilder` の記述:
  VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。

  定義:
    インタフェース `VelocityMailBuilder` 内の `isCacheEnabled`
  戻り値:
    メールデータをキャッシュする設定の場合は true
  関連項目:
    `VelocityMailBuilder.isCacheEnabled()`

### setCacheEnabled

    public void setCacheEnabled(boolean cacheEnabled)

  インタフェース `VelocityMailBuilder` の記述:
  VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。 デフォルトはキャッシュしない設定です。

  キャッシュのキーは、`buildMail()`メソッド引数のメールデータファイルのクラスパス或いはファイルパスです。 キャッシュに有効期限はありません。 また、メールデータファイルの内容が途中で更新されても、キャッシュされているメールデータは更新されませんので注意してください。

  `false`を指定してこのメソッドを呼ぶとメールデータキャッシュはクリアされます。

  定義:
    インタフェース `VelocityMailBuilder` 内の `setCacheEnabled`
  パラメータ:
    `cacheEnabled` - メールデータをキャッシュする場合は true
  関連項目:
    `VelocityMailBuilder.setCacheEnabled(boolean)`

### hasTemplateCache

    protected boolean hasTemplateCache(String key)

### putTemplateCache

    protected void putTemplateCache(String key,
                                    String templateXmlText)

### getTemplateCache

    protected String getTemplateCache(String key)

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

Copyright © 2004 OZACC. All Rights Reserved.