コンポーネント／マッパー関数定義ファイル書式ガイド

1. 定義ファイルについて
2. 定義ファイルの置き場所
   1. サーバー
   2. フローデザイナー
   3. 定義ファイルの分割形式
3. コンポーネント定義ファイル - ComponentDefine.xconf
   1. 名前空間と文書要素
   2. リファレンス
      1. ComponentDefine
      2. Component
      3. Class
      4. Message
      5. Param
      6. Resource
      7. Property
      8. AdditionalProp
      9. Category
      10. Listener
      11. PropertyListener
      12. Input
          1. SubConnector
      13. Output
          1. SubConnector
      14. FieldDef
          1. ストリームフォーマットがParameterList, Record, CSV, FixedLengthの場合
          2. ストリームフォーマットがXMLの場合
      15. Variables
4. マッパー関数定義ファイル - FunctionDefine.xconf
   1. 名前空間と文書要素
   2. リファレンス
      1. FunctionDefine
      2. Function
      3. Class
      4. Message
      5. Param
      6. Resource
      7. Property
      8. Listener
      9. PropertyListener
      10. Output
5. プロパティ
   1. 共通の定義
   2. プロパティ型
      1. string
      2. int
      3. double
      4. decimal
      5. boolean
      6. choice
      7. editableChoice
      8. datetime
      9. date
      10. time
      11. color
      12. remoteFile
      13. pathResolver
      14. group
      15. subflow
      16. exception
      17. connection
      18. holiday
      19. password
      20. loopProcess
      21. streamPassThrough
      22. xml
      23. xpath
      24. pluginCall
      25. variant
      26. componentName
      27. propertyName
      28. inputField
      29. subFunction
6. Listener
   1. プロパティの編集
   2. remoteFileプロパティの編集
   3. SubFlowController
   4. 条件式制御
   5. 外部ファイルをプロパティ検索
   6. コンポーネントの置き換え
   7. マッパー関数の置き換え
   8. アイコン変更
   9. 外部アプリケーション起動
   10. テンプレートから選択
7. PropertyListener
   1. プロパティ値による状態変更
   2. プロパティ値とDescriptionの同期
   3. コンポーネント入出力数出力数の動的制御
   4. マッパー関数出力数の動的制御

1 定義ファイルについて

フローサービスおよびフローデザイナーは起動時にコンポーネントとマッパー関数の定義ファイルを読み込みそれぞれの一覧を作成します。
ここではその定義ファイルの書式について説明します。

2 定義ファイルの置き場所

2.1 サーバー

「FLOWSERVICE_HOME/lib/flowlib」というフォルダーがコンポーネント／マッパー関数の実体クラスを含むjarファイルの置き場所となっています。
このjarファイルの中にロケール毎の定義ファイルを配置します。
標準コンポーネント／マッパー関数には英語、日本語、中国語の3つのロケールの定義ファイルが含まれています。

• コンポーネント定義ファイル(英語版) - META-INF/asteria/en/ComponentDefine.xconf
• コンポーネント定義ファイル(日本語版) - META-INF/asteria/ja/ComponentDefine.xconf
• コンポーネント定義ファイル(中国語版) - META-INF/asteria/zh_CN/ComponentDefine.xconf
• マッパー関数定義ファイル(英語版) - META-INF/asteria/en/FunctionDefine.xconf
• マッパー関数定義ファイル(日本語版) - META-INF/asteria/ja/FunctionDefine.xconf
• マッパー関数定義ファイル(中国語版) - META-INF/asteria/zh_CN/FunctionDefine.xconf

サーバー側では実行するマシンのロケールに対応した定義ファイルが読み込まれます。
対応するロケールの定義ファイルがない場合は英語版の定義ファイルが読み込まれます。

※ jarの中には必ずしもコンポーネントとマッパー関数の定義ファイルの両方を用意する必要はなく、どちらか片方、実際に作成したクラスに対応するものだけを用意します。
どちらの定義ファイルも含まれていないjarファイルがこのフォルダーに置かれていても特にエラーにはなりませんが、初期化のチェックが入るので起動は遅くなります。

2.2 フローデザイナー

「DESIGNER_HOME/lib/flowlib」というフォルダーにフローサービスに配置したのと同じjarファイルを配置します。
フローデザイナーではサーバーと異なり、jarの中にある定義ファイルが直接読み込まれるのではなく、ロケールに応じた定義ファイルがOSのユーザーフォルダー以下に作成されるフローデザイナーのプロファイル用のフォルダーの「conf」直下に以下の名前にリネームされて保存されます。

• コンポーネント定義ファイル(ComponentDefine.xconf) - <jarファイル名>.xsc
• マッパー関数定義ファイル(FunctionDefine.xconf) - <jarファイル名>.xmf

起動時にconfフォルダー下にあるファイルとjarファイルの日付を比較して、jarファイルの方が新しい場合は再度jarファイルから定義ファイルが読み出されてconfフォルダーに保存されます。

標準コンポーネント／マッパー関数の定義ファイルもすべて同フォルダーに保存されているので独自のコンポーネント／マッパー関数を作成する際にはそれらを参考にして定義を行うことができます。
また、テスト段階では、コンポーネントやマッパー関数の実体クラスを作成する前に定義ファイルだけを用意してフローデザイナーの動作を検証することも可能です。

2.3 定義ファイルの分割形式

以下で説明する定義ファイルの形式はjarファイルに含まれる(PROFILE_HOME/confに保存される)形式ですが、実際には定義ファイルはコンポーネント(またはマッパー関数)の単位で作成されます。
JavaInterpreterのウィザードによって生成される定義ファイルのスケルトンはこちらの分割形式のファイルであり、ビルド時に分割された定義ファイルが収集されてロケールに応じた定義ファイルが生成され jarファイル内の適切な場所に配置されます。
分割形式の場合でも、各国語版の定義が1ファイルに含まれるようになるだけで定義内容自体は全く一緒です。

3 コンポーネント定義ファイル - ComponentDefine.xconf

3.1 名前空間と文書要素

• 名前空間 - http://www.infoteria.com/asteria/flowengine/definition
• 文書要素 - ComponentDefine

この文書内で説明される要素は全て上記の名前空間に属します。
ただし、自作プロパティの作成などによりSDKユーザーによって定義ファイルが拡張される場合はその限りではありません。

3.2 リファレンス

3.2.1 ComponentDefine

文書要素

ComponentDefine要素は複数のComponent要素を持ちます。

3.2.2 Component

コンポーネントの情報を記述するための要素です。
コンポーネント名(name属性)はフローサービス内でユニークである必要があります。
サーバー側、デザイナー側の両方で評価されます。

Component要素は以下の要素を持つことができます。

• Class - 必ず1個
• Message - 0個以上複数
• Param - 0個以上複数
• Resource - 0個以上複数
• Property - 0個以上複数
• AdditionalProp - 0個以上複数
• Category - 0個以上複数
• Listener - 0個以上複数
• PropertyListener - 0個以上複数
• Input - type="normal"またはtype="end"のコンポーネントでは必ず1個。それ以外は0個
• Output - type="normal"またはtype="start"のコンポーネントでは1個以上複数。それ以外は0個

Class要素は要素内容の最初に位置する必要がありますが、他の要素の出現順序は任意です。
Property要素はその出現順でフローデザイナーのプロパティインスペクタに表示されます。

3.2.3 Class

要素内容としてコンポーネントの実装クラスのクラス名を指定します。
サーバー側でのみ解釈され、デザイナー側では使用されません。
(Designerはxfpファイルを編集することがその責務であり、実際にコンポーネントを実行する必要がないからです。)
デザイナー側ではコンポーネントの持つプロパティなどの情報はProperty要素などを元に構築されます。

Class要素は要素内容としてクラス名を持つので、子要素はありません。

3.2.4 Message

実装クラスが使用するエラーメッセージなどの文字列リソースをここに記述することができます。
サーバー側でのみ解釈され、デザイナー側では使用されません。
ここで定義された文字列はComponent#getMessageメソッドで取得できます。
key属性はComponent要素内でユニークでなければなりません。
文字列中では「%1〜%3」というシンボルが使用でき、それぞれComponent#getMessageの引数で置換されます。
※key属性には数値以外も記述できますが、数値を推奨します。

Message要素は要素内容としてメッセージ内容の文字列を持つので、子要素はありません。

3.2.5 Param

サーバー側の実装クラスが使用するパラメーターをここに記述することができます。
サーバー側でのみ解釈され、デザイナー側では使用されません。
ここで定義された文字列はComponentManager#getParamメソッドで取得できます。
name属性はComponent要素内でユニークでなければなりません。

Param要素は要素内容としてパラメーター文字列を持つので、子要素はありません。

3.2.6 Resource

デザイナー側の実装クラスが使用するエラーメッセージなどの文字列リソースをここに記述することができます。
デザイナー側でのみ解釈され、サーバー側では使用されません。
例えば、独自のListenerクラスを作成する場合にその中で使用する文字列リソースなどをここで定義します。
ここで定義された文字列はComponent#getMetaData()#getResourceメソッドで取得できます。
key属性はComponent要素内でユニークでなければなりません。
文字列中では「%1〜%3」というシンボルが使用でき、それぞれComponent#getMetaData()#getResourceの引数で置換されます。

Resource要素は要素内容としてリソース文字列を持つので、子要素はありません。

3.2.7 Property

コンポーネントの持つプロパティ情報を記述します。
フローデザイナーではひとつのProperty要素がインスペクタ上でのひとつのプロパティに対応します。
(このProperty要素以降の要素はフローデザイナー側で使用される要素です。)

Property定義の詳細については後述のプロパティの章を参照してください。

3.2.8 AdditionalProp

AdditionalPropとはインスペクタ上でタブページとなるプロパティのことです。
独自のAdditonalPropを作成することにより、インスペクタにタブページを追加し、 その上に専用の入力インターフェースを作成することができます。

AdditionalProp要素にはその実装クラスが解釈する独自の属性／子要素を持つことがあります。
次節で説明するCategoryはAdditionalPropのひとつです。

「<Category name="Category1" ...」と定義するところを
「<AdditionalProp name="Category1" class="com.infoteria.asteria.flowbuilder2.property.category.CategoryProperty"...」
と定義しても同じですが、Categoryは多くのコンポーネントで使用されるので専用の要素が用意されています。

3.2.9 Category

Categoryとはインスペクタ上でタブページの上にテーブル形式の入力インターフェースを持つプロパティのことです。
テーブルの列はProperty要素を用いて定義します。

Categoryの各列の定義にはProperty要素を使用します。
Property要素の定義方法についてはPropertyの章を参照してください。

例 - RDBGetコンポーネントのSQLParameter

<Category key="Name" mapping="true" name="SQLParameter displayName="SQLパラメーター" readonly="true" value="Default">
	<Property displayName="パラメーター名" name="Name" toolTip="header name" type="string"/>
	<Property displayName="データ型" name="Type" toolTip="data type" type="choice">
		<Value>String</Value>
		<ChoiceItem ref="DataType"/>
	</Property>
	<Property displayName="値" name="Default" toolTip="header value" type="string"/>
</Category>

3.2.10 Listener

コンポーネントの動作を拡張するためのListenerを追加します。
Listenerを追加するとコンポーネントの追加やリンクなどの各種イベントでの処理を拡張することが出来ます。

Listener定義の詳細については後述のListenerの章を参照してください。

3.2.11 PropertyListener

コンポーネントのPropertyの動作を拡張するためのPropertyListenerを追加します。
PropertyListenerを追加するとプロパティ値設定時の処理を拡張することが出来ます。

PropertyListener定義の詳細については後述のPropertyListenerの章を参照してください。

3.2.12 Input

Startコンポーネントと独立コンポーネント以外のコンポーネントは1組の入力コネクタセットを持ちます。
入力コネクタセットはひとつのデフォルトコネクタと、0個以上複数のサブコネクタを持つことができます。
デフォルトコネクタの情報はInput要素自身に、サブコネクタの情報は子要素であるSubConnector要素に記述します。

Input要素は次の子要素を持つことができます。

• FieldDef
  defineStream属性がtrueの場合にひとつだけ持つことができます。
  入力コネクタでフィールド定義を行う場合にその初期値を定義することができます。
  FieldDef要素がない場合は、フィールド定義の初期値は空になります。
• SubConnector
  0個以上複数のSubConnectorを定義することができます。
  

3.2.12.1 SubConnector

SubConnector要素は「location」以外はInput要素と同じ属性を定義できます。
子要素としてはSubConnector要素を持つことはできませんが、defineStream=trueの場合は、
FieldDef要素を持つことができます。

3.2.13 Output

終了コンポーネントと独立コンポーネント以外のコンポーネントは1組以上の出力コネクタセットを持ちます。
出力コネクタセットはひとつのデフォルトコネクタと、0個以上複数のサブコネクタを持つことができます。
デフォルトコネクタの情報はOutput要素自身に、サブコネクタの情報は子要素であるSubConnector要素に記述します。

出力コネクタセットが複数定義された場合はそれぞれの出力コネクタセットはブランチに対応します。

Output要素は次の子要素を持つことができます。

• FieldDef
  フィールド定義のデフォルト値を指定する場合に定義します。
  例えばFileListコンポーネントは最初からデフォルトのフィールド定義を持っています。
• Variables
  出力するストリームにストリーム変数を付加する場合に定義します。
  例えばFileGetコンポーネントはFilePathなどのストリーム変数を出力ストリームに付加します。
• SubConnector
  0個以上複数のSubConnectorを定義することができます。
  

3.2.13.1 SubConnector

SubConnector要素は「location」以外はOutput要素と同じ属性を定義できます。
子要素としてはSubConnector要素を持つことはできませんが、FieldDef要素、Variables要素はOutput要素と 同様に定義可能です。

3.2.14 FieldDef

ストリーム定義のデフォルトのストリームフォーマットが、ParameterList、Record、CSV、FixedLength、XML のいずれかである場合はデフォルトのフィールド定義を持つことができます。
デフォルトのフィールド定義を行う場合にはFieldDef要素を使用します。

FieldDefの定義内容はストリームフォーマットによって異なります。
ストリーム定義のdefaultで指定したフォーマットに合わせて定義してください。

3.2.14.1 ストリームフォーマットがParameterList, Record, CSV, FixedLengthの場合

FieldDefの子要素として複数のField要素を持つことができます。
ひとつのField要素は定義の1行に相当します。
Field要素は以下の属性を持ちます。

Field要素は空要素です。

例 - FileListコンポーネントのOutput(デフォルトのフィールド定義がある)

<Output accept="Record">
	<FieldDef readonly="true">
		<Field name="FileName" type="String"/>
		<Field name="FilePath" type="String"/>
		<Field name="FileDate" type="DateTime"/>
		<Field name="FileSize" type="Integer"/>
		<Field name="FileType" type="String"/>
	</FieldDef>
</Output>

3.2.14.2 ストリームフォーマットがXMLの場合

XMLの場合、FieldDefの子要素は名前空間を定義するNamespace要素(複数可)と、 XMLの構造を定義するField要素になります。
Field要素はXML構造のひとつのElementあるいはAttributeに相当し、Field要素の子要素として別のField要素を持つことができます。
FieldDef要素の直接の子要素であるField要素は文書要素となるのでひとつしか定義できません。

Namepspace要素は以下の属性を持ちます。

Namespace要素は空要素です。

Field要素は以下の属性を持ちます。

3.2.15 Variables

Variables要素はストリーム変数を定義する場合に使用します。
Variable要素自身には属性はなく、子要素として複数のField要素を持つことができます。
ひとつのField要素がひとつの変数定義に相当します。
Field要素は以下の属性を持ちます。

Field要素は空要素です。

例 - FileGetコンポーネントのOutput(ストリーム変数が定義されている)

<Output accept="Binary;Text;HTML;CSV;FixedLength;XML;MIME" default="XML">
	<Variables>
		<Field name="FilePath" type="String"/>
		<Field name="FileDate" type="DateTime"/>
		<Field name="FileSize" type="Integer"/>
	</Variables>
</Output>

4 マッパー関数定義ファイル - FunctionDefine.xconf

4.1 名前空間と文書要素

• 名前空間 - http://www.infoteria.com/asteria/flowengine/definition
• 文書要素 - FunctionDefine

この文書内で説明される要素は全て上記の名前空間に属します。
ただし、自作プロパティの作成などによりSDKユーザーによって定義ファイルが拡張される場合はその限りではありません。

4.2 リファレンス

4.2.1 FunctionDefine

文書要素

FunctionDefine要素は複数のFunction要素を持ちます。

4.2.2 Function

マッパー関数の情報を記述するための要素です。
マッパー関数名(name属性)はフローサービス内でユニークである必要があります。
サーバー側、デザイナー側の両方で評価されます。

Function要素は以下の要素を持つことができます。

• Class - 必ず1個
• Message - 0個以上複数
• Param - 0個以上複数
• Resource - 0個以上複数
• Property - 0個以上複数
• Listener - 0個以上複数
• PropertyListener - 0個以上複数
• Output - 出力が複数あるマッパー関数では1個。それ以外は0個

Class要素は要素内容の最初に位置する必要がありますが、他の要素の出現順序は任意です。
Property要素はその出現順でフローデザイナーのプロパティインスペクタに表示されます。

4.2.3 Class

要素内容としてマッパー関数の実装クラスのクラス名を指定します。
サーバー側でのみ解釈され、デザイナー側では使用されません。
(フローデザイナーはxfpファイルを編集することがその責務であり、実際にマッパー関数を実行する必要がないからです。)
デザイナー側ではマッパー関数の持つプロパティなどの情報はProperty要素などを元に構築されます。

Class要素は要素内容としてクラス名を持つので、子要素はありません。

4.2.4 Message

実装クラスが使用するエラーメッセージなどの文字列リソースをここに記述することができます。
サーバー側でのみ解釈され、デザイナー側では使用されません。
ここで定義された文字列はFunction#getMessageメソッドで取得できます。
key属性はFunction要素内でユニークでなければなりません。
文字列中では「%1〜%3」というシンボルが使用でき、それぞれFunction#getMessageの引数で置換されます。
※key属性には数値以外も記述できますが、数値を推奨します。

Message要素は要素内容としてメッセージ内容の文字列を持つので、子要素はありません。

4.2.5 Param

サーバー側の実装クラスが使用するパラメーターをここに記述することができます。
サーバー側でのみ解釈され、デザイナー側では使用されません。
ここで定義された文字列はFunctionManager#getParamメソッドで取得できます。
name属性はFunction要素内でユニークでなければなりません。

Param要素は要素内容としてパラメーター文字列を持つので、子要素はありません。

4.2.6 Resource

デザイナー側の実装クラスが使用するエラーメッセージなどの文字列リソースをここに記述することができます。
デザイナー側でのみ解釈され、サーバー側では使用されません。
例えば、独自のListenerクラスを作成する場合にその中で使用する文字列リソースなどをここで定義します。
ここで定義された文字列はFunction#getMetaData()#getResourceメソッドで取得できます。
key属性はFunction要素内でユニークでなければなりません。
文字列中では「%1〜%3」というシンボルが使用でき、それぞれFunction#getMetaData()#getResourceの引数で置換されます。

Resource要素は要素内容としてリソース文字列を持つので、子要素はありません。

4.2.7 Property

マッパー関数の持つプロパティ情報を記述します。
フローデザイナーではひとつのProperty要素がインスペクタ上でのひとつのプロパティに対応します。
(このProperty要素以降の要素はデザイナー側で使用される要素です。)

Property定義の詳細については後述のプロパティの章を参照してください。

4.2.8 Listener

マッパー関数の動作を拡張するためのListenerを追加します。
Listenerを追加するとマッパー関数の追加やリンクなどの各種イベントでの処理を拡張することが出来ます。

Listener定義の詳細については後述のListenerの章を参照してください。

4.2.9 PropertyListener

マッパー関数のPropertyの動作を拡張するためのPropertyListenerを追加します。
PropertyListenerを追加するとプロパティ値設定時の処理を拡張することが出来ます。

PropertyListener定義の詳細については後述のPropertyListenerの章を参照してください。

4.2.10 Output

マッパー関数が複数の出力を持つ場合に定義します。
省略された場合はマッパー関数はひとつの出力だけを持ちます。

例 - Split関数は２つの出力を持つ

<Function category="文字列" icon="str_split.png" inputCount="2" name="Split" toolTip="文字列を分割します">
	<Class>com.infoteria.asteria.flowlibrary2.mapper.string.Split</Class>
	<Property name="Separator" displayName="分割キー文字列" required="true" replace="2" type="string"/>
	<Property choiceItem="Left=左(先頭)から&#xa;Right=右(末尾)から" name="SearchDir" displayName="検索方向" type="choice">Left</Property>
	<Property choiceItem="None=出力に含めない&#xa;Left=出力1に含める&#xa;Right=出力2に含める" name="SeparatorMode" displayName="キーの扱い" type="choice">None</Property>
	<Output count="2"/>
	<Listener class="com.infoteria.asteria.flowbuilder2.plugin.IconReplace" icon="str_split2.png"/>
</Function>

5 プロパティ

プロパティの定義はProperty要素を使用して行われます。
Property要素の持つ属性／子要素にはProperty要素共通のものとtype固有のものの両方があります。
(例えばtype="choice"のプロパティはchoiceItem属性またはChoiceItem要素を持ちます。)
まずProperty要素共通の内容について説明し、その後個別のプロパティ型について説明します。

5.1 共通の定義

標準的なProperty定義ではProperty要素は子要素としてValueという要素を持ち、その要素内容としてプロパティ のデフォルト値を記述することができます。
(typeによっては他の子要素を持つプロパティもあります。)
ただし、Property要素の子要素がValue要素だけの場合は、Value要素を省略してデフォルト値を直接Property要素の要素内容として記述することができます。
つまり

<Property name="Prop1" type="string">
	<Value>DefaultValue</Value>
</Property>

という定義内容は

<Property name="Prop1" type="string">DefaultValue</Property>

と書いても同じ意味であり、ほとんどの場合後者の省略形式が使用されます。

loadingDefault属性はリリース済みのコンポーネントやマッパー関数にプロパティが追加された場合などに使用します。
プロパティが新たに追加された場合、それ以前のバージョンで作成されたxfpファイルには当然そのプロパティの設定情報は含まれません。
この場合xfpを読み込んだ時点で追加されたプロパティにはデフォルト値が設定されますが、この時に使用する値を通常のデフォルト値(パレットから新たに配置した場合に 使用されるデフォルト値)とは異なる値にしたい場合にloadingDefaultを使用します。

5.2 プロパティ型

組み込みのプロパティ(Property要素のtypeで指定できるもの)には以下のものがあります。

5.2.1 string

String型のプロパティです。
デフォルトではエディタは1行ダイアログになります。
複数行の文字列を入力する場合はProperty要素でeditor="multiline"を指定します。

5.2.2 int

Integer型のプロパティです。
エディタでは数値以外入力できません。

5.2.3 double

Double型のプロパティです。
エディタでは数値以外入力できません。

5.2.4 decimal

BigDecimal型のプロパティです。
エディタでは数値以外入力できません。

5.2.5 boolean

Boolean型のプロパティです。
デフォルトではエディタは「はい」「いいえ」の選択形式なりますが、true/false属性で表示名を変更することもできます。
(xfpへの保存は表示に関わらず常にtrueかfalseになります。)

5.2.6 choice

文字列選択形式のプロパティです。
choiceには、略記法と正記法の2つの方法のどちらかで選択肢となる文字列を定義します。

略記法

Property要素にchoiceItem属性を持たせ、そこに選択肢となる文字列を「&#xa;」で区切って羅列します。
実名(xfpファイルに保存される値)と異なる表示名を指定するには、実名=表示名のように指定します。

例：

<Property choiceItem="Left=左(先頭)から&#xa;Right=右(末尾)から" name="SearchDir" displayName="検索方向" type="choice">Left</Property>

注意：
実名、表示名には、「=」を含む定義はできません。「=」を使用する場合は正記法で定義してください。

正記法

Property要素の子要素としてChoiceItem要素を定義します。
ChoiceItem要素の定義方法は以下の通りです。

ChoiceItem要素は子要素として、Include要素、Exclude要素を複数持つことができます。

Include要素では選択肢に追加する値を定義します。(ref属性と組み合わせて使用することもできます。)
Include要素は次の属性を持ちます。

Exclude要素では選択肢から除外する値を定義します。(ref属性と組み合わせで使用します。)
Exclude要素は次の属性を持ちます。

Include、Exclude共に空要素です。

例：

<Property name="SearchDir" displayName="検索方向" type="choice">
  <ChoiceItem>
    <Include name="Left" displayName="左(先頭)から"/>
    <Include name="Right" displayName="右(末尾)から"/>
  </ChoiceItem>
</Property>

5.2.7 editableChoice

文字列選択形式のプロパティです。
choiceが選択肢からの選択しかできないのに対し、editableChoiceは文字列の直接入力を許します。
choiceの場合と同様に選択肢を正記法または略記法で定義する必要があります。

5.2.8 datetime

日付と時刻を指定するためのプロパティです。 エディタはカレンダー形式になります。

5.2.9 date

日付を指定するためのプロパティです。 エディタはカレンダー形式になります。

5.2.10 time

時刻を指定するためのプロパティです。 エディタはスピンボックスになります。

5.2.11 color

色を選択するためのプロパティです。
xfp上にはColorがRGB形式で保存されます。xfpに保存された値をJavaのColorクラスに戻すためのコードは以下の様になります。

   String propValue;
   Color c = new Color((int)Long.parseLong(propValue, 16), true);

5.2.12 remoteFile

文字列プロパティの一種ですが、エディタとしてフローサービスホームフォルダーのファイルオープンダイアログを備えています。
ダイアログからファイルを選択するとそのパスがプロパティ値として設定されます。

多くの場合remoteFileプロパティは次に説明するpathResolverプロパティとの組み合わせて使用されます。
対応するpathResolverプロパティの値が「プロジェクトフォルダ」の場合はプロジェクトファイルのあるフォルダからの相対パスが、 「ホームフォルダー」の場合はホームフォルダーからの相対パスがプロパティ値として設定されます。
ただし「プロジェクトフォルダ」の場合でも選択したファイルのパスがプロジェクトフォルダの下位にあるファイルでない場合は、 pathResolverプロパティの値が「ホームフォルダー」に変更された上でホームフォルダーからのパスが設定されます。
対応するpathResolverプロパティがない場合はホームフォルダーからの相対パスが設定されます。

またpathResolverプロパティの設定に関わらず、プロパティ値として絶対パスを指定することもできます。
(ただしコンポーネントによっては絶対パスの指定が禁止されているものもあります。)

このプロパティでは追加の属性として以下を持つことができます。

また子要素としてFilter要素を追加することにより拡張子によるファイルのフィルタを追加することができます。
Filter要素は次の属性を持ちます。

5.2.13 pathResolver

pathResolverプロパティは上述のremoteFileプロパティの値がどこからのパスであるかを示すために使用されます。
対象となるremoteFileプロパティが何であるかはtarget属性で示されます。

pathResolverプロパティの設定値はほとんどの場合「プロジェクトフォルダ」、「ホームフォルダー」の2択であるか、 それに「実行ユーザーのホームフォルダー」を加えた3択となります。
通常はflowbuilder.xconfで定義されたChoiceItem「pathResolver」を参照することで選択肢を定義します。

<Property displayName="ファイルパスの起点" mapping="false" name="HomeDirectory" target="FilePath" type="pathResolver">
	<ChoiceItem ref="PathResolver">
		<Exclude name="ExecuteUser"/>
	</ChoiceItem>
	<Value>Relative</Value>
</Property>

pathResolverプロパティの値が「実行ユーザーのホームフォルダー」の場合はremoteFileプロパティのファイル選択ダイアログは あまり意味を持たないので、その場合はファイル名を直接タイプします。

5.2.14 group

groupはプロパティを階層化するための仕組みです。
type="group"を指定した場合にはProperty要素は別のProperty要素を子要素として持つことができインスペクタ上では階層表示されます。
(groupの子としてさらにgroupを指定することもできます。)

5.2.15 subflow

フローを選択するためのプロパティです。
エディタはフローの選択ダイアログになります。
このプロパティでは追加の属性として以下を持つことができます。

5.2.16 exception

Exceptionフローを選択するためのコンポーネント専用プロパティです。
Exceptionプロパティはインスペクタ上では他のプロパティとは別のカテゴリーに表示されます。
subflowとの違いは、ダイアログの選択肢に「エラーを無視する」「リクエストを終了する」「フローを終了する」があるかどうかです。

5.2.17 connection

ASMCで定義したコネクションを選択するためのプロパティです。
connection属性で選択させるコネクション種別を指定します。

5.2.18 holiday

FSMCで設定した休日設定を選択するためのプロパティです。
休日設定はコード内ではFlowEngine#getHolidayメソッドから利用できます。

5.2.19 password

文字列プロパティの1種ですが、xfpにはエンクリプトして保存されます。
またエディタでの入力、表示は「*」でマスクされ指定した文字列は隠されます。

5.2.20 loopProcess

コンポーネント専用のプロパティです。
Booleanプロパティの1種ですが、「true」「false」の切り替えと画面上でのストリームアイコンの表示が連動します。

ほとんどのコンポーネントは出力コネクタを一つしか持たないので特にstateやnameを指定する必要はありません。

loopProcessプロパティを使用する場合その対象となるコネクタのloop属性はloopProsssプロパティの初期値と揃えておく必要があります。
(そうしておかないと初期状態でストリームのアイコンが示すループ状態が実際の設定値と異なるという状態になります。)

5.2.21 streamPassThrough

コンポーネント専用のプロパティです。
Booleanプロパティの1種ですが、「true」「false」の切り替えと画面上でのStreamPassThroughアイコンの表示が連動します。

ほとんどのコンポーネントは入出力コネクタを一つしか持たないので特にこれらの属性を指定する必要はありません

このプロパティのデフォルト値をtrueにする場合はComponent要素のsptIcon属性もあわせてtrueにしてください。

5.2.22 xml

XMLをプロパティ値として持つプロパティです。
xfp上ではプロパティ値であるXMLの文書要素がProperty要素の子要素となります。

このプロパティには汎用のプロパティエディタはありません。
通常はこのプロパティはインスペクタ上では非表示とし、Listenerでこのプロパティ値を扱う処理を行うか、 次に説明するxpathプロパティのサンプルインスタンスを保持するための隠しプロパティとして使用されます。

5.2.23 xpath

stringプロパティの1種ですが、XPathを設定するための専用ダイアログをエディタとして備えています。

5.2.24 pluginCall

サーバー側のComponentに実装したpluginCallメソッドを実行してその結果をドロップダウンリストに表示するプロパティです。
使用するためには定義を行うだけではなくサーバー側で対応するpluginCallの実装を行わなければなりません。

pluginCallの実行時に設定するパラメーターはParam要素で指定できます。

ここから先に説明するプロパティは汎用のプロパティというよりもコンポーネント(マッパー関数)の用途に応じて カスタマイズされた特殊プロパティです。
場合によってはこのような専用のプロパティを作成することも出来ます。

5.2.25 variant

データ型に応じてエディタの切り替わるプロパティです。
Const関数のデータプロパティとマッパー変数で使用されています。

5.2.26 componentName

コンポーネント専用のプロパティです。
フロー上に存在するコンポーネント名を選択できます。

LoopEndコンポーネントで使用されています。

5.2.27 propertyName

コンポーネント専用のプロパティです。
直前のコンポーネントのプロパティ名を選択できます。

BranchByComponentPropertyコンポーネント、BranchByExceptionコンポーネントで使用されています。

5.2.28 inputField

コンポーネント専用のプロパティです。
直前のコンポーネントのフィールド名を選択できます。

RecordJoinコンポーネントで使用されています。

5.2.29 subFunction

サブ関数専用のプロパティです。
サブ関数を選択ダイアログから選択できます。

6 Listener

コンポーネントもマッパー関数もBaseObjectという抽象基底クラスを継承したオブジェクトです。
BaseObjectにはその各種イベントをハンドルするためのListenerを登録することができます。
Listenerは「com.infoteria.asteria.flowbuilder2.event.BaseObjectListener」インターフェースを実装するクラスで次のイベントをハンドルできます。

• コンポーネント(またはマッパー関数)が作成された直後
• コンポーネント(またはマッパー関数)が破棄された直後
• コンポーネント(またはマッパー関数)がフローに追加された直後
• コンポーネント(またはマッパー関数)がフローから削除された直後
• コンポーネント(またはマッパー関数)にリンクが追加された直後
• コンポーネント(またはマッパー関数)からリンクが削除された直後
• コンポーネント(またはマッパー関数)を含むフローがロードされた直後
• コンポーネント(またはマッパー関数)が複製された直後
• コンポーネント(またはマッパー関数)のポップアップメニューが表示される直前
• コンポーネント(またはマッパー関数)がダブルクリックされた時
• プロパティ検索や変数検索の実行時

Listener要素共通の属性としては次のものがあり、これ以外に個別のListenerが独自の要素や属性定義を持つこともあります。

汎用的な組み込みListenerとしては次のものがあります。

6.1 プロパティの編集

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.EditProperty

コンポーネント(またはMapper関数)のダブルクリック時に指定のプロパティのエディタを起動するListenerです。
また、ポップアップメニューに同じプロパティの編集メニューを追加することもできます。

switch属性が指定された場合、子要素としてCaseまたはDefault要素を定義して指定のプロパティの値に応じた編集対象プロパティを定義する必要があります。

Case要素は複数定義することができ、次の属性を持ちます。

Default要素ではマッチするCase要素がなかった場合の編集対象プロパティを指定します。

例1 - Const関数はダブルクリックで「データ」プロパティの編集を開始します。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.EditProperty" menuItem="データ編集" property="Data"/>

例2 - Table関数は「「テーブルの指定方法」プロパティの値によって「テーブルの内容」か「ファイルパス」プロパティの編集を開始します。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.FileEditProperty" menuItem="テーブルの編集" switch="Mode">
    <Case value="Inline" property="InlineTable"/>
    <Case value="File" property="FilePath"/>
</Listener>

6.2 remoteFileプロパティの編集

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.FileEditProperty

remoteFileプロパティに特化したプロパティ編集のためのListenerで、 ダブルクリック時に指定のプロパティに既に値が設定されている場合はそのファイルを開き、 空の場合はエディタを起動(ファイル選択ダイアログを表示)します。

FileEditPropertyはEditProperyのサブクラスですのでswitch属性を指定した場合の子要素の定義方法はEditPropertyと同じです。
またその場合のtargetにはremoteFileプロパティ以外も指定することができます。

例 - FileGetコンポーネントはダブルクリックで「ファイルパス」プロパティの編集を開始します。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.FileEditProperty" menuItem="ファイルの編集..." property="FilePath"/>

6.3 SubFlowController

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.SubFlowController

subFlowプロパティのコントロールを行うためのListenerで、次のことが行えます。

• ダブルクリック時に指定のsubFlowプロパティに値が設定されているなら、そのフローを開く
  値が設定されていない場合はフロー選択ダイアログを表示する
• メニューにサブフローの編集メニューを追加する
• メニューにサブフロー情報の更新メニューを追加する

サブフロー情報の更新メニューは対象となるsubFlowプロパティにparam属性が指定されている場合、自動的に組み込まれます。

例 - Timerコンポーネント

<Component category="Schedule" icon="timer.png" name="TimerRequest" toolTip="タイマーによる実行">
	<Property mapping="false" name="Exception" type="exception"/>
	<Property name="Time" type="int">0</Property>
	<Property mapping="true" name="Flow" type="subflow" param="Argument" allowRecursive="true"/>
	<Property mapping="false" name="KeepSession" type="boolean">false</Property>
	<Category name="Argument" key="Name" value="Default" mapping="output">
		<Property name="Name" toolTip="header name" type="string" readonly="true"/>
		<Property name="Type" toolTip="data type" type="choice" readonly="true">
			<Value>String</Value>
			<ChoiceItem ref="DataType"/>
		</Property>
		<Property name="Default" displayName="Value" type="string" editor="multiline"/>
	</Category>
	<Listener class="com.infoteria.asteria.flowbuilder2.plugin.SubFlowController" 
		menuItem="フローの編集..." property="Flow"/>
	<Input accept="ALL"/>
	<Output streamPassThrough="true"/>
</Component>

6.4 条件式制御

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.SearchConditionSpec

変数ナビの検索に指定のプロパティが条件式であるものとして検索対象に含めるためのListenerです。
例えば指定のプロパティの値が「$flow.var1 = 0」であれば変数ペインでフロー変数「var1」を選択した時の変数ナビの表示にこのコンポーネントが加わります。
また変数名を変更した場合にもこのListenerでプロパティを監視しておくと自動的に条件式に変数名の変更が反映されます。

例 - BranchStartコンポーネントの「Condition」プロパティを変数検索の対象にします。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.SearchConditionSpec" property="Condition"/>

6.5 外部ファイルをプロパティ検索

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.SearchExternalFile

プロパティ検索でプロパティ値として指定された外部ファイルを検索対象に含みます。
(検索ダイアログで「拡張検索」がチェックされた場合のみ有効です。)

例 - Velocityコンポーネントの「TemplateFilename」プロパティで指定されたファイルをプロパティ検索の対象にします。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.SearchExternalFile" encodingProp="TemplateEncoding" filepathProp="TemplateFilename"/>

6.6 コンポーネントの置き換え

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.ReplaceComponent

コンポーネントを別のコンポーネントに置き換えるメニューを追加するListenerです。
置き換え対象のコンポーネントは子要素「Component」で定義します。

例 - RDBGetコンポーネントはSQLCallコンポーネントに置き換えることができます。

<Listener caption="コンポーネントの置き換え" class="com.infoteria.asteria.flowbuilder2.plugin.ReplaceComponent">
	<Component name="SQLCall">
		<Property name="Mode">SQL-Record</Property>
	</Component>
</Listener>

6.7 マッパー関数の置き換え

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.ReplaceFunction

マッパー関数を別のマッパー関数に置き換えるメニューを追加するListenerです。
置き換え対象のマッパー関数は子要素「Function」で定義します。
(子要素の名前がFunctionに変わる以外はコンポーネントの置き換えと同じです。)

例 - 「==」などの比較関数は別の比較関数に置き換えることができます。

<Listener caption="関数の置き換え" class="com.infoteria.asteria.flowbuilder2.plugin.ReplaceFunction">
	<Function name="NotEqual"/>
	<Function name="Greater"/>
	<Function name="GreaterEqual"/>
	<Function name="Less"/>
	<Function name="LessEqual"/>
</Listener>

6.8 アイコン変更

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.IconReplace

パレット上で使用されているアイコンをドロップ時に別のアイコンに変更するためのListenerです。
Split関数などドロップ時のアイコンの大きさが通常のアイコンサイズよりも大きい場合や、 アイコンに文字列を描画したい場合に使用します。

6.9 外部アプリケーション起動

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.LaunchExternalApp

外部アプリケーションを起動するためのListenerです。
このListenerは実行時には

1. preExecuteメソッドを実行
2. 指定のコマンドを実行
3. postExecuteメソッドを実行

という順序で動作します。
デフォルトではpreExecute、postExecuteの各メソッドは

• preExecute - SaveProperty要素で指定されたプロパティの値をファイルに書き出す
• postExecute - preExecuteで書き出したファイルを読み込んで指定のプロパティに書き戻す

という処理を行いますが、通常はこのListenerのサブクラスを作成してpreExecute/postExecuteでの処理を独自に実装します。
(ExcelBuilder、PDFBuilderはそのようにして作成されています。)

子要素としてSaveProperty要素を定義することで外部アプリケーションの実行前後にファイルにプロパティ値を書き出し＆書き戻すことができます。
SaveProperty要素は次の属性を持ちます。

例 - 次のような定義で指定のプロパティ値をメモ帳で編集できるようになります。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.LaunchExternalApp" menuItem="ソースの編集" 
    command="notepad.exe Temp.java" appName="Javaソース編集" execDir="toolshedDir">
	<SaveProperty name="Source" filename="Temp.java"/>
</Listener>

6.10 テンプレートから選択

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.SelectTemplate

コンポーネント(マッパー関数)の右クリックメニューに標準で存在する「テンプレートから選択」をダブルクリック時に実行するListenerです。
通常テンプレートファイルはユーザーが「テンプレートに追加」を行うことではじめて作成され、それまでは「テンプレートから選択」は実行できませんが、 このListenerではテンプレートファイルがない場合にjarファイル内からテンプレートファイルを抜き出すことができます。
言い換えればコンポーネント開発者が最初から標準のテンプレートファイルをjarファイル内に組み込んで提供することができます。

例 - OnSheetRestコンポーネントでは標準でOnSheetのWebAPIの設定がテンプレートファイルで提供されています。

<Listener class="com.infoteria.asteria.flowbuilder2.plugin.SelectTemplate" filename="OnSheetRest_jp.xml"/>

7 PropertyListener

プロパティでの値の設定時に処理を行うPropertyListenrを作成することができます。
PropertyListenerは「com.infoteria.asteria.gui.property.event.PropertyChangeListener」インターフェースを実装するクラスで次のイベントをハンドルできます。

• プロパティ値が変更される直前
• プロパティ値が変更された直後

PropertyListener要素共通の属性としては次のものがあり、これ以外に個別のPropertyListenerが独自の要素や属性定義を持つこともあります。

汎用的な組み込みPropertyListenerとしては次のものがあります。

7.1 プロパティ値による状態変更

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.SimplePropertyController

SimplePropertyControllerはあるプロパティの値の変更と同時に別の状態を変更することのできるPropertyListenerです。
SimplePropertyControllerはプロパティ値に対応する動作の定義のためにCase要素とDefault要素を使用します。
Case要素はPropertyListener要素の子要素として複数定義でき、Default要素はPropertyListener要素の子要素としてひとつだけ定義できます。
それぞれのCase要素とDefault要素では動作を指定するための要素を複数定義できます。

Case要素は複数定義することができ、次の属性を持ちます。

Default要素は属性を持ちません。
Default要素では監視するプロパティの値がどのCase要素ともマッチしなかった場合の動作を定義します。

CaseおよびDefault要素がもつことのできる子要素には次のものがあります。

• Target - プロパティの状態変更
• Icon - アイコンの変更
• Message - メッセージペインへのメッセージの出力
• Connector - コンポーネント専用。コネクタの増減
• Output - マッパー関数専用。出力コネクタの増減

Target要素を使用すると監視するプロパティ値の変更に連動して別のプロパティの状態を変更することができます。

Target要素には複数の状態変更の属性を同時に定義できます。

例 - HTTPGetコンポーネントではUseConnectionプロパティの変化に伴いプロパティの可視性が変化します。

<PropertyListener class="com.infoteria.asteria.flowbuilder2.plugin.SimplePropertyController" target="UseConnection">
	<Case value="true">
		<Target name="Connection" visible="true"/>
		<Target name="ConnectionInfo" visible="false"/>
	</Case>
	<Case value="false">
		<Target name="Connection" visible="false"/>
		<Target name="ConnectionInfo" visible="true"/>
	</Case>
</PropertyListener>

PropertyListenerは初期化時には実行されません。
上の例で言えばUseConnectionの初期値が「true」であるならば初期状態ではConnectionInfoは表示したくないので、
ConnectionInfoのProperty要素定義にvisible="false"も定義します。

Icon要素を使用すると監視するプロパティ値の変更に連動してアイコンを変更することができます。
またアイコン上に文字列を描画することもできるので、フロー内のアイコンをより説明的にすることが可能です。

Message要素を使用すると監視するプロパティ値の変更に連動して要素内容として定義した文字列をメッセージペインに出力することができます。
メッセージはプロパティのオーナーであるオブジェクトとひもづいているのでダブルクリック時にはそのワークスペースの表示がそのオブジェクトにジャンプします。

Connector要素を使用すると監視するプロパティ値の変更に連動してコンポーネントの入出力コネクタを増減させることができます。
ただし現在はまだ仕様変更の可能性があるため使用することはできません。

Output要素を使用すると監視するプロパティ値の変更に関数の出力数を変更することができます。

例 - DateSplit関数では出力対象プロパティの値に応じて出力数が変わります。

<PropertyListener class="com.infoteria.asteria.flowbuilder2.plugin.SimplePropertyController" target="Mode">
	<Case value="DateTime">
		<Output count="8" tileIcon="false"/>
		<Icon filename="DateSplit_datetime.png"/>
		<Target name="WeekDay" visible="true"/>
	</Case>
	<Case value="Date">
		<Output count="4" tileIcon="false"/>
		<Icon filename="DateSplit_date.png"/>
		<Target name="WeekDay" visible="true"/>
	</Case>
	<Case value="Time">
		<Output count="4" tileIcon="false"/>
		<Icon filename="DateSplit_time.png"/>
		<Target name="WeekDay" visible="false"/>
	</Case>
</PropertyListener>

7.2 プロパティ値とDescriptionの同期

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.DescriptionSynchronizer

指定したプロパティの値にDescription内容が連動します。
ユーザーが自分でDescriptionを編集してプロパティ値とDescription内容が異なる状態になった場合は連動しなくなります。

例 - Const関数では「データ」プロパティ値とDescriptionが連動します。

<PropertyListener class="com.infoteria.asteria.flowbuilder2.plugin.DescriptionSynchronizer" target="Data"/>

7.3 コンポーネント入出力数出力数の動的制御

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.ConnectorController

int型のプロパティを指定してその設定値にコンポーネントの入出力コネクタ数を連動させます。

例 - OnSheetInputComponentでは隠しプロパティ「OutputCount」と出力コネクタ数が連動します。

<Property name="OutputCount" type="int" visible="false">1</Property>
<PropertyListener class="com.infoteria.asteria.flowbuilder2.plugin.ConnectorController" mode="output" target="OutputCount"/>

ConnectorControllerの使い方としてはこのように監視するプロパティは非表示にしておき別途独自に作成したコンポーネントエディタ からプロパティを設定して制御することが多いです。

7.4 マッパー関数出力数の動的制御

クラス名 - com.infoteria.asteria.flowbuilder2.plugin.FunctionOutputPropertyListener

int型のプロパティを指定してその設定値にマッパー関数の出力コネクタ数を連動させます。

例 - JavaInterpreter関数やSplit関数では「出力数」プロパティ値と出力コネクタ数が連動します。

<PropertyListener class="com.infoteria.asteria.flowbuilder2.plugin.FunctionOutputPropertyListener" target="Count"/>