org.seasar.framework.convention
インタフェース NamingConvention

既知の実装クラスの一覧:

NamingConventionImpl

public interface NamingConvention

命名規約のためのインターフェースです。

作成者:

higa, shot

メソッドの概要

java.lang.String	adjustViewRootPath() viewのルートパスが/のみの場合に取り除きます。
java.lang.String	fromActionNameToPageName(java.lang.String actionName) アクション名をページ名に変換します。
java.lang.String	fromActionNameToPath(java.lang.String actionName) アクション名をViewのパスに変換します。
java.lang.String	fromClassNameToComponentName(java.lang.String className) クラス名をコンポーネント名に変換します。
java.lang.String	fromClassNameToShortComponentName(java.lang.String className) クラス名を短いコンポーネント名に変換します。
java.lang.String	fromClassNameToSuffix(java.lang.String className) クラス名をsuffixに変換します。
java.lang.Class	fromComponentNameToClass(java.lang.String componentName) コンポーネント名をClassに変換します。
java.lang.String	fromComponentNameToPartOfClassName(java.lang.String componentName) コンポーネント名をクラス名の一部に変換します。
java.lang.String	fromComponentNameToSuffix(java.lang.String componentName) コンポーネント名をsuffixに変換します。
java.lang.String	fromPageClassToPath(java.lang.Class pageClass) ページのClassをViewのパスに変換します。
java.lang.String	fromPageNameToPath(java.lang.String pageName) ページ名をViewのパスに変換します。
java.lang.String	fromPathToActionName(java.lang.String path) Viewのパスをアクション名に変換します。
java.lang.String	fromPathToPageName(java.lang.String path) Viewのパスをページ名に変換します。
java.lang.String	fromSuffixToPackageName(java.lang.String suffix) suffixをパッケージ名に変換します。
java.lang.String	getActionSuffix() Actionクラスのsuffixを返します。
java.lang.String	getConnectorPackageName() Connectorクラスのパッケージ名を返します。
java.lang.String	getConnectorSuffix() Connectorクラスのsuffixを返します。
java.lang.String	getConverterPackageName() Converterクラスのパッケージ名を返します。
java.lang.String	getConverterSuffix() Converterクラスのsuffixを返します。
java.lang.String	getDaoPackageName() Daoクラスのパッケージ名を返します。
java.lang.String	getDaoSuffix() Daoクラスのsuffixを返します。
java.lang.String	getDtoPackageName() Dtoクラスのパッケージ名を返します。
java.lang.String	getDtoSuffix() Dtoクラスのsuffixを返します。
java.lang.String	getDxoPackageName() Dxoクラスのパッケージ名を返します。
java.lang.String	getDxoSuffix() Dxoクラスのsuffixを返します。
java.lang.String	getEntityPackageName() Entityクラスのパッケージ名を返します。
java.lang.String	getHelperPackageName() Helperクラスのパッケージ名を返します。
java.lang.String	getHelperSuffix() Helperクラスのsuffixを返します。
java.lang.String[]	getIgnorePackageNames() 無視するルートパッケージ名の配列を返します。
java.lang.String	getImplementationPackageName() 実装用のパッケージ名を返します。
java.lang.String	getImplementationSuffix() 実装クラスのsuffixを返します。
java.lang.String	getInterceptorPackageName() Interceptorクラスのパッケージ名を返します。
java.lang.String	getInterceptorSuffix() Interceptorクラスのsuffixを返します。
java.lang.String	getLogicPackageName() Logicクラスのパッケージ名を返します。
java.lang.String	getLogicSuffix() Logicクラスのsuffixを返します。
java.lang.String	getPageSuffix() Pageクラスのsuffixを返します。
java.lang.String[]	getRootPackageNames() ルートパッケージ名の配列を返します。
java.lang.String	getServicePackageName() Serviceクラスのパッケージ名を返します。
java.lang.String	getServiceSuffix() Serviceクラスのsuffixを返します。
java.lang.String	getSubApplicationRootPackageName() サブアプリケーションのルートパッケージ名を返します。
java.lang.String	getValidatorPackageName() Validatorクラスのパッケージ名を返します。
java.lang.String	getValidatorSuffix() Validatorクラスのsuffixを返します。
java.lang.String	getViewExtension() viewの拡張子を返します。
java.lang.String	getViewRootPath() viewのルートパスを返します。
boolean	isHotdeployTargetClassName(java.lang.String className) HOT deployのターゲットのクラス名かどうかを返します。
boolean	isIgnoreClassName(java.lang.String className) 無視するクラス名かどうかを返します。
boolean	isSkipClass(java.lang.Class clazz) 規約に従っていないスキップすべきクラスかどうか返します。
boolean	isTargetClassName(java.lang.String className) ターゲットのクラス名かどうかを返します。
boolean	isTargetClassName(java.lang.String className, java.lang.String suffix) ターゲットのクラス名かどうかを返します。
boolean	isValidViewRootPath(java.lang.String path) 妥当なViewのルートパスかどうかを返します。
java.lang.Class	toCompleteClass(java.lang.Class clazz) 最終的に利用されるクラスに変換します。
java.lang.String	toImplementationClassName(java.lang.String className) クラス名を実装クラス名に変換します。
java.lang.String	toInterfaceClassName(java.lang.String className) クラス名をインターフェース名に変換します。

メソッドの詳細

getViewRootPath

public java.lang.String getViewRootPath()

viewのルートパスを返します。

戻り値:

adjustViewRootPath

public java.lang.String adjustViewRootPath()

viewのルートパスが/のみの場合に取り除きます。 例:"/" -> "", "/hoge" -> "/hoge"

戻り値:

getViewExtension

public java.lang.String getViewExtension()

viewの拡張子を返します。

戻り値:

getImplementationSuffix

public java.lang.String getImplementationSuffix()

実装クラスのsuffixを返します。

戻り値:

実装クラスのsuffix

getPageSuffix

public java.lang.String getPageSuffix()

Pageクラスのsuffixを返します。

戻り値:

Pageクラスのsuffix

getActionSuffix

public java.lang.String getActionSuffix()

Actionクラスのsuffixを返します。

戻り値:

Actionクラスのsuffix

getServiceSuffix

public java.lang.String getServiceSuffix()

Serviceクラスのsuffixを返します。

戻り値:

Serviceクラスのsuffix

getDxoSuffix

public java.lang.String getDxoSuffix()

Dxoクラスのsuffixを返します。

戻り値:

Dxoクラスのsuffix

getLogicSuffix

public java.lang.String getLogicSuffix()

Logicクラスのsuffixを返します。

戻り値:

Logicクラスのsuffix

getDaoSuffix

public java.lang.String getDaoSuffix()

Daoクラスのsuffixを返します。

戻り値:

Daoクラスのsuffix

getHelperSuffix

public java.lang.String getHelperSuffix()

Helperクラスのsuffixを返します。

戻り値:

Helperクラスのsuffix

getInterceptorSuffix

public java.lang.String getInterceptorSuffix()

Interceptorクラスのsuffixを返します。

戻り値:

Interceptorクラスのsuffix

getValidatorSuffix

public java.lang.String getValidatorSuffix()

Validatorクラスのsuffixを返します。

戻り値:

Validatorクラスのsuffix

getConverterSuffix

public java.lang.String getConverterSuffix()

Converterクラスのsuffixを返します。

戻り値:

Converterクラスのsuffix

getDtoSuffix

public java.lang.String getDtoSuffix()

Dtoクラスのsuffixを返します。

戻り値:

Dtoクラスのsuffix

getConnectorSuffix

public java.lang.String getConnectorSuffix()

Connectorクラスのsuffixを返します。

戻り値:

Connectorクラスのsuffix

getSubApplicationRootPackageName

public java.lang.String getSubApplicationRootPackageName()

サブアプリケーションのルートパッケージ名を返します。

戻り値:

サブアプリケーションのルートパッケージ名

getImplementationPackageName

public java.lang.String getImplementationPackageName()

実装用のパッケージ名を返します。

戻り値:

実装用のパッケージ名

getDxoPackageName

public java.lang.String getDxoPackageName()

Dxoクラスのパッケージ名を返します。

戻り値:

Dxoクラスのパッケージ名

getLogicPackageName

public java.lang.String getLogicPackageName()

Logicクラスのパッケージ名を返します。

戻り値:

Logicクラスのパッケージ名

getDaoPackageName

public java.lang.String getDaoPackageName()

Daoクラスのパッケージ名を返します。

戻り値:

Daoクラスのパッケージ名

getEntityPackageName

public java.lang.String getEntityPackageName()

Entityクラスのパッケージ名を返します。

戻り値:

Entityクラスのパッケージ名

getDtoPackageName

public java.lang.String getDtoPackageName()

Dtoクラスのパッケージ名を返します。

戻り値:

Dtoクラスのパッケージ名

getServicePackageName

public java.lang.String getServicePackageName()

Serviceクラスのパッケージ名を返します。

戻り値:

Serviceクラスのパッケージ名

getInterceptorPackageName

public java.lang.String getInterceptorPackageName()

Interceptorクラスのパッケージ名を返します。

戻り値:

Interceptorクラスのパッケージ名

getValidatorPackageName

public java.lang.String getValidatorPackageName()

Validatorクラスのパッケージ名を返します。

戻り値:

Validatorクラスのパッケージ名

getConverterPackageName

public java.lang.String getConverterPackageName()

Converterクラスのパッケージ名を返します。

戻り値:

Converterクラスのパッケージ名

getHelperPackageName

public java.lang.String getHelperPackageName()

Helperクラスのパッケージ名を返します。

戻り値:

Helperクラスのパッケージ名

getConnectorPackageName

public java.lang.String getConnectorPackageName()

Connectorクラスのパッケージ名を返します。

戻り値:

Connectorクラスのパッケージ名

getRootPackageNames

public java.lang.String[] getRootPackageNames()

ルートパッケージ名の配列を返します。

戻り値:

ルートパッケージ名の配列

getIgnorePackageNames

public java.lang.String[] getIgnorePackageNames()

無視するルートパッケージ名の配列を返します。

戻り値:

無視するルートパッケージ名の配列

fromSuffixToPackageName

public java.lang.String fromSuffixToPackageName(java.lang.String suffix)

suffixをパッケージ名に変換します。

パラメータ:

suffix -

戻り値:

パッケージ名

fromClassNameToShortComponentName

public java.lang.String fromClassNameToShortComponentName(java.lang.String className)

クラス名を短いコンポーネント名に変換します。 短いコンポーネント名とは、"サブアプリケーション名_"がついていないコンポーネント名です。

パラメータ:

className -

戻り値:

短いコンポーネント名

fromClassNameToComponentName

public java.lang.String fromClassNameToComponentName(java.lang.String className)

クラス名をコンポーネント名に変換します。

パラメータ:

className -

戻り値:

コンポーネント名

fromComponentNameToClass

public java.lang.Class fromComponentNameToClass(java.lang.String componentName)

コンポーネント名をClassに変換します。

パラメータ:

componentName -

戻り値:

Class

toImplementationClassName

public java.lang.String toImplementationClassName(java.lang.String className)

クラス名を実装クラス名に変換します。

パラメータ:

className -

戻り値:

実装クラス名

toInterfaceClassName

public java.lang.String toInterfaceClassName(java.lang.String className)

クラス名をインターフェース名に変換します。

パラメータ:

className -

戻り値:

インターフェース名

isSkipClass

public boolean isSkipClass(java.lang.Class clazz)

規約に従っていないスキップすべきクラスかどうか返します。

パラメータ:

clazz -

戻り値:

規約に従っていないスキップすべきクラス

toCompleteClass

public java.lang.Class toCompleteClass(java.lang.Class clazz)

最終的に利用されるクラスに変換します。 通常は、実装クラスですが、DaoのようにInterceptorで実体化される場合、 インターフェースの場合もあります。

パラメータ:

clazz -

戻り値:

最終的に利用されるクラス

fromComponentNameToPartOfClassName

public java.lang.String fromComponentNameToPartOfClassName(java.lang.String componentName)

コンポーネント名をクラス名の一部に変換します。 "_"は"."に"_"の後ろは大文字に変換されます。 例えば、コンポーネント名がhoge_fooの場合、hoge.Fooになります。

パラメータ:

componentName -

戻り値:

クラス名の一部

fromComponentNameToSuffix

public java.lang.String fromComponentNameToSuffix(java.lang.String componentName)

コンポーネント名をsuffixに変換します。 コンポーネント名の最後から探して最初の大文字までを抽出して、 先頭を小文字に変換したものが、 suffixになります。

パラメータ:

componentName -

戻り値:

suffix

fromClassNameToSuffix

public java.lang.String fromClassNameToSuffix(java.lang.String className)

クラス名をsuffixに変換します。

パラメータ:

className -

戻り値:

suffix

fromPathToPageName

public java.lang.String fromPathToPageName(java.lang.String path)

Viewのパスをページ名に変換します。

パラメータ:

path -

戻り値:

ページ名

fromPathToActionName

public java.lang.String fromPathToActionName(java.lang.String path)

Viewのパスをアクション名に変換します。

パラメータ:

path -

戻り値:

アクション名

fromPageNameToPath

public java.lang.String fromPageNameToPath(java.lang.String pageName)

ページ名をViewのパスに変換します。

パラメータ:

pageName -

戻り値:

Viewのパス

fromPageClassToPath

public java.lang.String fromPageClassToPath(java.lang.Class pageClass)

ページのClassをViewのパスに変換します。

パラメータ:

pageClass -

戻り値:

Viewのパス

fromActionNameToPath

public java.lang.String fromActionNameToPath(java.lang.String actionName)

アクション名をViewのパスに変換します。

パラメータ:

actionName -

戻り値:

Viewのパス

fromActionNameToPageName

public java.lang.String fromActionNameToPageName(java.lang.String actionName)

アクション名をページ名に変換します。

パラメータ:

actionName -

戻り値:

ページ名

isTargetClassName

public boolean isTargetClassName(java.lang.String className,
                                 java.lang.String suffix)

ターゲットのクラス名かどうかを返します。

パラメータ:

className -

suffix -

戻り値:

ターゲットのクラス名かどうか

isTargetClassName

public boolean isTargetClassName(java.lang.String className)

ターゲットのクラス名かどうかを返します。

パラメータ:

className -

戻り値:

ターゲットのクラス名かどうか

isHotdeployTargetClassName

public boolean isHotdeployTargetClassName(java.lang.String className)

HOT deployのターゲットのクラス名かどうかを返します。

パラメータ:

className -

戻り値:

HOT deployのターゲットのクラス名かどうか

isIgnoreClassName

public boolean isIgnoreClassName(java.lang.String className)

無視するクラス名かどうかを返します。

パラメータ:

className -

戻り値:

無視するクラス名かどうか

isValidViewRootPath

public boolean isValidViewRootPath(java.lang.String path)

妥当なViewのルートパスかどうかを返します。

パラメータ:

path -

戻り値:

妥当なViewのルートパスかどうか