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

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

NamingConventionImpl

public interface NamingConvention

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

作成者:

higa, shot

メソッドの概要

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

メソッドの詳細

getViewRootPath

public String getViewRootPath()

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

戻り値:

adjustViewRootPath

public String adjustViewRootPath()

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

戻り値:

getViewExtension

public String getViewExtension()

viewの拡張子を返します。

戻り値:

getImplementationSuffix

public String getImplementationSuffix()

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

戻り値:

実装クラスのsuffix

getPageSuffix

public String getPageSuffix()

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

戻り値:

Pageクラスのsuffix

getActionSuffix

public String getActionSuffix()

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

戻り値:

Actionクラスのsuffix

getServiceSuffix

public String getServiceSuffix()

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

戻り値:

Serviceクラスのsuffix

getDxoSuffix

public String getDxoSuffix()

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

戻り値:

Dxoクラスのsuffix

getLogicSuffix

public String getLogicSuffix()

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

戻り値:

Logicクラスのsuffix

getDaoSuffix

public String getDaoSuffix()

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

戻り値:

Daoクラスのsuffix

getHelperSuffix

public String getHelperSuffix()

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

戻り値:

Helperクラスのsuffix

getInterceptorSuffix

public String getInterceptorSuffix()

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

戻り値:

Interceptorクラスのsuffix

getValidatorSuffix

public String getValidatorSuffix()

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

戻り値:

Validatorクラスのsuffix

getConverterSuffix

public String getConverterSuffix()

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

戻り値:

Converterクラスのsuffix

getDtoSuffix

public String getDtoSuffix()

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

戻り値:

Dtoクラスのsuffix

getConnectorSuffix

public String getConnectorSuffix()

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

戻り値:

Connectorクラスのsuffix

getSubApplicationRootPackageName

public String getSubApplicationRootPackageName()

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

戻り値:

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

getImplementationPackageName

public String getImplementationPackageName()

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

戻り値:

実装用のパッケージ名

getDxoPackageName

public String getDxoPackageName()

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

戻り値:

Dxoクラスのパッケージ名

getLogicPackageName

public String getLogicPackageName()

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

戻り値:

Logicクラスのパッケージ名

getDaoPackageName

public String getDaoPackageName()

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

戻り値:

Daoクラスのパッケージ名

getEntityPackageName

public String getEntityPackageName()

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

戻り値:

Entityクラスのパッケージ名

getDtoPackageName

public String getDtoPackageName()

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

戻り値:

Dtoクラスのパッケージ名

getServicePackageName

public String getServicePackageName()

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

戻り値:

Serviceクラスのパッケージ名

getInterceptorPackageName

public String getInterceptorPackageName()

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

戻り値:

Interceptorクラスのパッケージ名

getValidatorPackageName

public String getValidatorPackageName()

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

戻り値:

Validatorクラスのパッケージ名

getConverterPackageName

public String getConverterPackageName()

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

戻り値:

Converterクラスのパッケージ名

getHelperPackageName

public String getHelperPackageName()

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

戻り値:

Helperクラスのパッケージ名

getConnectorPackageName

public String getConnectorPackageName()

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

戻り値:

Connectorクラスのパッケージ名

getRootPackageNames

public String[] getRootPackageNames()

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

戻り値:

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

getIgnorePackageNames

public String[] getIgnorePackageNames()

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

戻り値:

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

fromSuffixToPackageName

public String fromSuffixToPackageName(String suffix)

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

パラメータ:

suffix -

戻り値:

パッケージ名

fromClassNameToShortComponentName

public String fromClassNameToShortComponentName(String className)

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

パラメータ:

className -

戻り値:

短いコンポーネント名

fromClassNameToComponentName

public String fromClassNameToComponentName(String className)

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

パラメータ:

className -

戻り値:

コンポーネント名

fromComponentNameToClass

public Class fromComponentNameToClass(String componentName)

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

パラメータ:

componentName -

戻り値:

Class

toImplementationClassName

public String toImplementationClassName(String className)

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

パラメータ:

className -

戻り値:

実装クラス名

toInterfaceClassName

public String toInterfaceClassName(String className)

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

パラメータ:

className -

戻り値:

インターフェース名

isSkipClass

public boolean isSkipClass(Class clazz)

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

パラメータ:

clazz -

戻り値:

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

toCompleteClass

public Class toCompleteClass(Class clazz)

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

パラメータ:

clazz -

戻り値:

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

fromComponentNameToPartOfClassName

public String fromComponentNameToPartOfClassName(String componentName)

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

パラメータ:

componentName -

戻り値:

クラス名の一部

fromComponentNameToSuffix

public String fromComponentNameToSuffix(String componentName)

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

パラメータ:

componentName -

戻り値:

suffix

fromClassNameToSuffix

public String fromClassNameToSuffix(String className)

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

パラメータ:

className -

戻り値:

suffix

fromPathToPageName

public String fromPathToPageName(String path)

fromPathToActionName

public String fromPathToActionName(String path)

fromPageNameToPath

public String fromPageNameToPath(String pageName)

fromPageClassToPath

public String fromPageClassToPath(Class pageClass)

fromActionNameToPath

public String fromActionNameToPath(String actionName)

fromActionNameToPageName

public String fromActionNameToPageName(String actionName)

isTargetClassName

public boolean isTargetClassName(String className,
                                 String suffix)

isTargetClassName

public boolean isTargetClassName(String className)

isIgnoreClassName

public boolean isIgnoreClassName(String className)

isValidViewRootPath

public boolean isValidViewRootPath(String path)