jp.oarts.pirka.iop.tool.core.business
インタフェース FileCreatorSampleModelerPlugin

すべてのスーパーインタフェース:
Plugin, java.io.Serializable
既知の実装クラスの一覧:
BasicHtmlFileCreator, BasicHtmlJavaFileCreator, CsvFileCreator, CsvFileInputJavaFileCreator, CsvFileOutputJavaFileCreator, CsvFileOutputJavaSample, DaoFileCreator, DataBaseFileCreator, FileCreatorSampleModelerSimplePlugin, FileCreatorSampleModelerTextCreatorSimplePlugin, GaeDaoFileCreator, GaeMstMntSample, MntHtmlFileCreator, MntHtmlJavaFileCreator, MstMntSample, MultiMstMntSample, SearcherDaoFileCreator, SelectListFileCreator, ValueObjectJavaFileCreator, VirtualDbTableFileCreator, WebAppFileCreator

public interface FileCreatorSampleModelerPlugin
extends Plugin

ファイルクリエータープラグイン、サンプルモデラープラグインインターフェース

作成者:
ito

メソッドの概要
 void afterCheckAttribute(int dataId, java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap, InterfaceProject interfaceProject)
          属性項目チェックが正常に終了した後に呼び出される
属性より自動的にインターフェースの変更などを行うときに使用する
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる
 boolean canAttach()
          インターフェースにアタッチ可能か調べる
 boolean canExecute()
          実行可能なプログインか
 void checkAttribute(int dataId, java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap, InterfaceProject interfaceProject)
          全行の属性項目のチェックを行う
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる
 void checkAttribute(int dataId, int itemId, java.util.HashMap<java.lang.String,AttributeData> dataMap, InterfaceProject interfaceProject)
          属性項目のチェックを行う
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる エラーになった属性項目はその名前をerrrorKeyListに追加する
 AttributeFileImage create(java.util.HashMap<java.lang.String,ParameterData> dataMap, InterfaceProject interfaceProject)
          ファイル作成処理
 java.lang.String getAttributeComment()
          属性のコメントを取得する
 AttributeItem getAttributeItem(java.lang.String name)
          このプラグインのアッタチさたインターフェースに付加される属性項目取得
 AttributeItem[] getAttributeItems()
          このプラグインのアッタチさたインターフェースに付加される属性項目の一覧取得
 PluginType getPluginType()
          プラグインタイプの取得
 void preCheckAttribute(int dataId, java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap, InterfaceProject interfaceProject)
          属性項目チェックを行う前に呼び出される
属性より自動的にインターフェースの変更などを行うときに使用する
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる
 boolean useDisableItemsAttribute()
          属性設定画面でインクルード内の無効項目は使用しないかの確認
 
インタフェース jp.oarts.pirka.iop.tool.core.business.Plugin から継承されたメソッド
checkParameter, getComment, getName, getNameJp, getParameterComment, getParameterItems, useSaveAndLoadParameter
 

メソッドの詳細

getAttributeComment

java.lang.String getAttributeComment()
属性のコメントを取得する

戻り値:
属性のコメント

getPluginType

PluginType getPluginType()
プラグインタイプの取得

戻り値:
プラグインタイプ

canAttach

boolean canAttach()
インターフェースにアタッチ可能か調べる

戻り値:
true=アタッチ可能

canExecute

boolean canExecute()
実行可能なプログインか

戻り値:
true=実行可能、false=不可能

getAttributeItems

AttributeItem[] getAttributeItems()
このプラグインのアッタチさたインターフェースに付加される属性項目の一覧取得

戻り値:
属性項目の一覧

getAttributeItem

AttributeItem getAttributeItem(java.lang.String name)
このプラグインのアッタチさたインターフェースに付加される属性項目取得

パラメータ:
name - 属性項目名
戻り値:
属性項目

preCheckAttribute

void preCheckAttribute(int dataId,
                       java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap,
                       InterfaceProject interfaceProject)
                       throws InterfaceException
属性項目チェックを行う前に呼び出される
属性より自動的にインターフェースの変更などを行うときに使用する
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる

パラメータ:
dataId - インタフェースID
dataMap - 全データマップ(キー:インターフェース名、値:項目ID属性格納マップ(キー:インタフェース項目ID、値:項目属性値格納マップ( キー:属性項目名、値:属性値)))
interfaceProject - インタフェースプロジェクト
例外:
InterfaceException

afterCheckAttribute

void afterCheckAttribute(int dataId,
                         java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap,
                         InterfaceProject interfaceProject)
                         throws InterfaceException
属性項目チェックが正常に終了した後に呼び出される
属性より自動的にインターフェースの変更などを行うときに使用する
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる

パラメータ:
dataId - インタフェースID
dataMap - 全データマップ(キー:インターフェース名、値:項目ID属性格納マップ(キー:インタフェース項目ID、値:項目属性値格納マップ( キー:属性項目名、値:属性値)))
interfaceProject - インタフェースプロジェクト
例外:
InterfaceException

checkAttribute

void checkAttribute(int dataId,
                    int itemId,
                    java.util.HashMap<java.lang.String,AttributeData> dataMap,
                    InterfaceProject interfaceProject)
                    throws InterfaceException
属性項目のチェックを行う
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる エラーになった属性項目はその名前をerrrorKeyListに追加する

パラメータ:
dataId - インタフェースID
itemId - アイテムID
dataMap - 属性値格納マップ(キー:属性項目名、値:属性値)
interfaceProject - インタフェースプロジェクト
例外:
InterfaceException

checkAttribute

void checkAttribute(int dataId,
                    java.util.HashMap<java.lang.String,java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,AttributeData>>> dataMap,
                    InterfaceProject interfaceProject)
                    throws InterfaceException
全行の属性項目のチェックを行う
エラーが発生したらエラーメッセージをInterfaceExceptionにセットして投げる

パラメータ:
dataId - インタフェースID
dataMap - 全データマップ(キー:インターフェース名、値:項目ID属性格納マップ(キー:インタフェース項目ID、値:項目属性値格納マップ( キー:属性項目名、値:属性値)))
interfaceProject - インタフェースプロジェクト
例外:
InterfaceException

create

AttributeFileImage create(java.util.HashMap<java.lang.String,ParameterData> dataMap,
                          InterfaceProject interfaceProject)
                          throws InterfaceException
ファイル作成処理

パラメータ:
dataMap - ファイル作成に必要なパラメータデータマップ(キー:パラメータキー名、値:パラメータデータ)
interfaceProject - インタフェースプロジェクト
戻り値:
作成されたファイルイメージオブジェクト
例外:
InterfaceException

useDisableItemsAttribute

boolean useDisableItemsAttribute()
属性設定画面でインクルード内の無効項目は使用しないかの確認

戻り値:
true=使用する