AbstractVelocityWriterImpl (PEXA API Document)

java.lang.Object
- pexa.tool.ejb.AbstractVelocityWriterImpl

すべての実装されたインタフェース:

Writer

直系の既知のサブクラス:

EjbCompileInfoWriterImpl, EjbJarWriterImpl, VendorDdWriterImpl
```
public abstract class AbstractVelocityWriterImpl
extends java.lang.Object
implements Writer
```
EJB Docletより生成するファイルに応じたWriterクラスが継承すべき抽象クラス。 Velocity関連およびファイル出力関連の基本機能を提供する。

バージョン:

$Revision: 3518 $, $Date:: 2009-04-27 14:28:06 #$

作成者:

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static java.lang.String`	`APSERVER_WEBLOGIC` Application Serverの種別(BEA Weblogic)
`protected static java.lang.String`	`CLASS_COMMON_FINDER` PEXA CommonFinderBeanの基底クラス名称
`protected static java.lang.String`	`CLASS_ENTITY` PEXA EntityBeanの基底クラス名称
`protected static java.lang.String`	`CLASS_FACADE` PEXA FacadeBeanの基底クラス名称
`protected static java.lang.String`	`CLASS_FINDER` PEXA ObservableFinderBeanの基底クラス名称
`protected static java.lang.String`	`DEFAULT_ENCODING` デフォルトのファイルエンコーディング
`protected static java.lang.String`	`INTERFACE_ENTITY` EntityBeanのインタフェース名
`protected static java.lang.String`	`INTERFACE_MESSAGE` MessageDrivenBeanのインタフェース名
`protected static java.lang.String`	`INTERFACE_SESSION` SessionBeanのインタフェース名
`protected java.lang.String`	`outputEncoding` 出力ファイルのエンコーディング指定
`protected java.util.Map`	`param` 初期化パラメータ格納Map
`protected static java.lang.String`	`PROP_INPUTENCODING` プロパティ名(templateファイルのエンコーディング指定)
`protected static java.lang.String`	`PROP_OUTPUTENCODING` プロパティ名(出力ファイルのエンコーディング指定)
`protected java.util.Map`	`templateMap` Velocity templateのファイルオブジェクトMap
`protected static int`	`TYPE_ENTITY` EJBの種別(Entity)
`protected static int`	`TYPE_FACADE` EJBの種別(PEXA FacadeBase)
`protected static int`	`TYPE_FINDER` EJBの種別(PEXA Finder)
`protected static int`	`TYPE_MESSAGE` EJBの種別(Message Driven Bean)
`protected static int`	`TYPE_NOMATCH` EJBの種別(該当なし)
`protected static int`	`TYPE_SESSION` EJBの種別(Session Bean)
`protected org.apache.velocity.app.VelocityEngine`	`ve` Velocityエンジン

インタフェースから継承されたフィールド pexa.tool.ejb.Writer
APSERVER, APSERVER_HOME, EJBJAR_DTD, SHORT_ENV_NAME, TEMPLATEPATH, VENDER_DTD

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

AbstractVelocityWriterImpl()

コンストラクタ
コンストラクタと説明
`AbstractVelocityWriterImpl()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected int`	`checkType(com.sun.javadoc.ClassDoc classDoc)` 読み込むクラスの種別を判定する
`protected java.io.File`	`getOutputFile(com.sun.javadoc.ClassDoc sourceDoc, java.lang.String fileName)` 元になったクラスのファイル情報から、生成すべきファイルの名前を絶対パスで取得する。
`protected java.io.File`	`getOutputFile(com.sun.javadoc.ClassDoc sourceDoc, java.lang.String dir, java.lang.String fileName)` 元になったクラスのファイル情報から、生成すべきファイルの名前を絶対パスで取得する。
`protected java.lang.String`	`getParameter(java.lang.String key)` 初期化パラメータを取得する
`protected java.lang.String[]`	`getParameterArray(java.lang.String key)` 初期化パラメータを取得する
`protected org.apache.velocity.Template`	`getTemplate(java.lang.String templateName)` Velocityのtemplateオブジェクトを取得する
`void`	`init(java.util.Map param)` 初期化を行う
`protected org.apache.velocity.app.VelocityEngine`	`initVelocity(java.util.Map param)` VelocityEngineを取得する
`protected boolean`	`isModified(com.sun.javadoc.ClassDoc sourceDoc, java.lang.String templateName, java.io.File outputFile)` 生成元のファイルと出力ファイルのタイムスタンプを比較し、生成元が変更されているかを判定する
`protected void`	`log(java.lang.String message)` ログ出力を行う
`protected java.lang.String`	`merge(java.lang.String template, org.apache.velocity.VelocityContext vcontext)` VelocityテンプレートとVelocityContextの内容をマージし、内容をStringで取得する。
`protected void`	`readOptionTags(com.sun.javadoc.ClassDoc classDoc, java.lang.String[] tagList, org.apache.velocity.VelocityContext vcontext)` クラス情報よりオプショナルタグの内容を読み込み、VelocityContextに設定する該当のタグが設定されていなければ無視する
`protected void`	`readTags(com.sun.javadoc.ClassDoc classDoc, java.lang.String[] tagList, org.apache.velocity.VelocityContext vcontext)` クラス情報よりタグの内容を読み込み、 VelocityContextに設定する
`protected void`	`writeFile(java.lang.String source, java.io.File outputFile)` ファイルに出力する(テキスト形式のみ)

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

インタフェースから継承されたメソッド pexa.tool.ejb.Writer
write

- フィールドの詳細
  - PROP_INPUTENCODING
```
protected static final java.lang.String PROP_INPUTENCODING
```
    プロパティ名(templateファイルのエンコーディング指定)
    
    関連項目:
    
    定数フィールド値
  - PROP_OUTPUTENCODING
```
protected static final java.lang.String PROP_OUTPUTENCODING
```
    プロパティ名(出力ファイルのエンコーディング指定)
    
    関連項目:
    
    定数フィールド値
  - INTERFACE_ENTITY
```
protected static final java.lang.String INTERFACE_ENTITY
```
    EntityBeanのインタフェース名
    
    関連項目:
    
    定数フィールド値
  - INTERFACE_SESSION
```
protected static final java.lang.String INTERFACE_SESSION
```
    SessionBeanのインタフェース名
    
    関連項目:
    
    定数フィールド値
  - INTERFACE_MESSAGE
```
protected static final java.lang.String INTERFACE_MESSAGE
```
    MessageDrivenBeanのインタフェース名
    
    関連項目:
    
    定数フィールド値
  - CLASS_ENTITY
```
protected static final java.lang.String CLASS_ENTITY
```
    PEXA EntityBeanの基底クラス名称
    
    関連項目:
    
    定数フィールド値
  - CLASS_FINDER
```
protected static final java.lang.String CLASS_FINDER
```
    PEXA ObservableFinderBeanの基底クラス名称
    
    関連項目:
    
    定数フィールド値
  - CLASS_COMMON_FINDER
```
protected static final java.lang.String CLASS_COMMON_FINDER
```
    PEXA CommonFinderBeanの基底クラス名称
    
    関連項目:
    
    定数フィールド値
  - CLASS_FACADE
```
protected static final java.lang.String CLASS_FACADE
```
    PEXA FacadeBeanの基底クラス名称
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_ENCODING
```
protected static final java.lang.String DEFAULT_ENCODING
```
    デフォルトのファイルエンコーディング
    
    関連項目:
    
    定数フィールド値
  - TYPE_NOMATCH
```
protected static final int TYPE_NOMATCH
```
    EJBの種別(該当なし)
    
    関連項目:
    
    定数フィールド値
  - TYPE_ENTITY
```
protected static final int TYPE_ENTITY
```
    EJBの種別(Entity)
    
    関連項目:
    
    定数フィールド値
  - TYPE_SESSION
```
protected static final int TYPE_SESSION
```
    EJBの種別(Session Bean)
    
    関連項目:
    
    定数フィールド値
  - TYPE_MESSAGE
```
protected static final int TYPE_MESSAGE
```
    EJBの種別(Message Driven Bean)
    
    関連項目:
    
    定数フィールド値
  - TYPE_FINDER
```
protected static final int TYPE_FINDER
```
    EJBの種別(PEXA Finder)
    
    関連項目:
    
    定数フィールド値
  - TYPE_FACADE
```
protected static final int TYPE_FACADE
```
    EJBの種別(PEXA FacadeBase)
    
    関連項目:
    
    定数フィールド値
  - APSERVER_WEBLOGIC
```
protected static final java.lang.String APSERVER_WEBLOGIC
```
    Application Serverの種別(BEA Weblogic)
    
    関連項目:
    
    定数フィールド値
  - param
```
protected java.util.Map param
```
    初期化パラメータ格納Map
  - ve
```
protected org.apache.velocity.app.VelocityEngine ve
```
    Velocityエンジン
  - outputEncoding
```
protected java.lang.String outputEncoding
```
    出力ファイルのエンコーディング指定
  - templateMap
```
protected java.util.Map templateMap
```
    Velocity templateのファイルオブジェクトMap
- コンストラクタの詳細
  - AbstractVelocityWriterImpl
```
public AbstractVelocityWriterImpl()
```
- メソッドの詳細
  - init
```
public void init(java.util.Map param)
```
    初期化を行う
    
    定義:
    
    init インタフェース内 Writer
    
    パラメータ:
    
    param - 初期化パラメータを格納したMap
  - log
```
protected void log(java.lang.String message)
```
    ログ出力を行う
    
    パラメータ:
    
    message - ログ出力するメッセージ
  - getParameter
```
protected java.lang.String getParameter(java.lang.String key)
```
    初期化パラメータを取得する
    
    パラメータ:
    
    key - 取得項目のキー
    
    戻り値:
    
    パラメータの値(String)
  - getParameterArray
```
protected java.lang.String[] getParameterArray(java.lang.String key)
```
    初期化パラメータを取得する
    
    パラメータ:
    
    key - 取得項目のキー
    
    戻り値:
    
    パラメータの値(オブジェクト)
  - getTemplate
```
protected org.apache.velocity.Template getTemplate(java.lang.String templateName)
                                            throws WriteFatalException
```
    Velocityのtemplateオブジェクトを取得する
    
    パラメータ:
    
    templateName - テンプレートファイル名
    
    戻り値:
    
    指定されたファイルを基にしたTemplateオブジェクト
    
    例外:
    
    WriteFatalException
  - initVelocity
```
protected org.apache.velocity.app.VelocityEngine initVelocity(java.util.Map param)
```
    VelocityEngineを取得する
    
    パラメータ:
    
    param - 初期化パラメータを格納したMap
    
    戻り値:
    
    初期化済のVelocityEngineオブジェクト
  - merge
```
protected java.lang.String merge(java.lang.String template,
                                 org.apache.velocity.VelocityContext vcontext)
                          throws WriteFatalException
```
    VelocityテンプレートとVelocityContextの内容をマージし、内容をStringで取得する。
    
    パラメータ:
    
    template - マージするVelocity templateファイル名
    
    vcontext - マージする内容を設定したVelocityContext
    
    戻り値:
    
    マージ結果の内容
    
    例外:
    
    WriteFatalException - 回復不能なエラーが発生した場合
  - writeFile
```
protected void writeFile(java.lang.String source,
                         java.io.File outputFile)
                  throws java.io.IOException
```
    ファイルに出力する(テキスト形式のみ)
    
    パラメータ:
    
    source - ファイル内容(テキスト)
    
    outputFile - 出力ファイルオブジェクト
    
    例外:
    
    java.io.IOException - ファイルの書き込みが失敗
  - checkType
```
protected int checkType(com.sun.javadoc.ClassDoc classDoc)
```
    読み込むクラスの種別を判定する
    
    パラメータ:
    
    classDoc - 読み込むクラスの情報
    
    戻り値:
    
    クラスの種別。TYPE_ENTITY, TYPE_SESSION, TYPE_MESSAGE のうちのいずれか。該当しなければTYPE_NOMATCH。
  - getOutputFile
```
protected java.io.File getOutputFile(com.sun.javadoc.ClassDoc sourceDoc,
                                     java.lang.String dir,
                                     java.lang.String fileName)
```
    元になったクラスのファイル情報から、生成すべきファイルの名前を絶対パスで取得する。
    
    パラメータ:
    
    sourceDoc - 生成元になるクラスの情報
    
    fileName - 出力ファイル名称(パスなし)
    
    戻り値:
    
    出力ファイルのFileオブジェクト
  - getOutputFile
```
protected java.io.File getOutputFile(com.sun.javadoc.ClassDoc sourceDoc,
                                     java.lang.String fileName)
```
    元になったクラスのファイル情報から、生成すべきファイルの名前を絶対パスで取得する。
    
    パラメータ:
    
    sourceDoc - 生成元になるクラスの情報
    
    fileName - 出力ファイル名称(パスなし)
    
    戻り値:
    
    出力ファイルのFileオブジェクト
  - isModified
```
protected boolean isModified(com.sun.javadoc.ClassDoc sourceDoc,
                             java.lang.String templateName,
                             java.io.File outputFile)
```
    生成元のファイルと出力ファイルのタイムスタンプを比較し、生成元が変更されているかを判定する
    
    パラメータ:
    
    sourceDoc - 生成元のクラス情報
    
    outputFile - 出力ファイルオブジェクト
    
    戻り値:
    
    生成元が変更されていればtrue, されていなければfalse
  - readTags
```
protected void readTags(com.sun.javadoc.ClassDoc classDoc,
                        java.lang.String[] tagList,
                        org.apache.velocity.VelocityContext vcontext)
                 throws WriteException
```
    クラス情報よりタグの内容を読み込み、 VelocityContextに設定する
    
    パラメータ:
    
    classDoc - クラス情報オブジェクト
    
    tagList - 読み込み対象のタグ配列
    
    vcontext - 読み込んだタグの内容を設定するVelocityContext
    
    例外:
    
    WriteException - 読み込んだクラスに必要なタグが記述されていない
  - readOptionTags
```
protected void readOptionTags(com.sun.javadoc.ClassDoc classDoc,
                              java.lang.String[] tagList,
                              org.apache.velocity.VelocityContext vcontext)
```
    クラス情報よりオプショナルタグの内容を読み込み、VelocityContextに設定する該当のタグが設定されていなければ無視する
    
    パラメータ:
    
    classDoc - クラス情報オブジェクト
    
    tagList - 読み込み対象のタグ配列
    
    vcontext - 読み込んだタグの内容を設定するVelocityContext

クラス AbstractVelocityWriterImpl

フィールドのサマリー

インタフェースから継承されたフィールド pexa.tool.ejb.Writer

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド pexa.tool.ejb.Writer

フィールドの詳細

PROP_INPUTENCODING

PROP_OUTPUTENCODING

INTERFACE_ENTITY

INTERFACE_SESSION

INTERFACE_MESSAGE

CLASS_ENTITY

CLASS_FINDER

CLASS_COMMON_FINDER

CLASS_FACADE

DEFAULT_ENCODING

TYPE_NOMATCH

TYPE_ENTITY

TYPE_SESSION

TYPE_MESSAGE

TYPE_FINDER

TYPE_FACADE

APSERVER_WEBLOGIC

param

ve

outputEncoding

templateMap

コンストラクタの詳細

AbstractVelocityWriterImpl

メソッドの詳細

init

log

getParameter

getParameterArray

getTemplate

initVelocity

merge

writeFile

checkType

getOutputFile

getOutputFile

isModified

readTags

readOptionTags