jp.go.aist.dmrc.platform.beans.util

クラス PFStringFinderForList

java.lang.Object

jp.go.aist.dmrc.platform.beans.util.PFStringFinderForList

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataSelectEventSource, PFEventSource, PFProcessTerminateEventSource

public class PFStringFinderForList
extends java.lang.Object
implements PFComponent, PFProcessTerminateEventSource, PFDataSelectEventSource, PFXMLSerializable

ラベル付きリストデータ内部を指定した文字列（正規表現）で全文検索するコンポーネント。

PFObjectList/PFLabeledObjectListによる階層的なデータ構造を前提としている。 データにPFObjectTableが含まれている場合はその内部も検索する。 このコンポーネントから以下のイベントが発生する。

• 処理完了イベント

  トリガー	処理結果データ	イベント番号
  find メソッド呼出	検索結果のリスト (PFObjectList)	（なし）

• データ選択イベント

  トリガー	選択データ	イベント番号
  selectHitItem メソッド呼出	検索結果のパスリスト (PFObjectList)	（なし）

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
PFStringFinderForList() デフォルトコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFDataSelectListener(PFDataSelectListener lis) 引数で与えられたイベントリスナを登録し、 データ選択イベント発生時に処理を行う対象とする。
void	addPFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
void	find(java.lang.String p, PFObjectList list) リスト(PFObjectList/PFLabeledObjectList)内を正規表現文字列で検索する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
PFObjectList	getHitList() 検索時に指定したリスト直下の要素内で、検索にヒットした要素のリストを取得する。
java.util.Iterator	getPFDataSelectListenerList() データ選択イベントリスナ配列を取得する。
java.util.Iterator	getPFProcessTerminateListenerList() 処理完了イベントリスナ配列を取得する。
PFObjectList	getResult() 検索結果リストを取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFDataSelectListener(PFDataSelectListener lis) 引数で与えられたイベントリスナを削除し、 データ選択イベント発生時に処理を行う対象から外す。
void	removePFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
void	selectHitItem(int i) 検索結果リストから指定位置の結果を選択。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントのキー情報を設定する
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PFStringFinderForList

public PFStringFinderForList()

デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

関連項目:

PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

関連項目:

PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントのキー情報を設定する

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - 設定するコンポーネントのキー

関連項目:

PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

関連項目:

PFComponent.getComponentID()

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

関連項目:

PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

コンポーネントの文字列表現を返す。

関連項目:

PFComponent.getComponentString()

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()

処理完了イベントリスナ配列を取得する。

定義:

getPFProcessTerminateListenerList インタフェース内 PFProcessTerminateEventSource

戻り値:

イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。

定義:

addPFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。

定義:

removePFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 削除対象イベントリスナ

getPFDataSelectListenerList

public java.util.Iterator getPFDataSelectListenerList()

データ選択イベントリスナ配列を取得する。

定義:

getPFDataSelectListenerList インタフェース内 PFDataSelectEventSource

戻り値:

イベントリスナイテレータ

addPFDataSelectListener

public void addPFDataSelectListener(PFDataSelectListener lis)

引数で与えられたイベントリスナを登録し、 データ選択イベント発生時に処理を行う対象とする。

定義:

addPFDataSelectListener インタフェース内 PFDataSelectEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFDataSelectListener

public void removePFDataSelectListener(PFDataSelectListener lis)

引数で与えられたイベントリスナを削除し、 データ選択イベント発生時に処理を行う対象から外す。

定義:

removePFDataSelectListener インタフェース内 PFDataSelectEventSource

パラメータ:

lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

関連項目:

PFComponent.localeUpdated()

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

find

public void find(java.lang.String p,
                 PFObjectList list)
          throws PFException

リスト(PFObjectList/PFLabeledObjectList)内を正規表現文字列で検索する。

パラメータ:

p - 正規表現文字列(String)

list - 検索対象リスト(PFObjectList/PFLabeledObjectList)

例外:

PFException - イベント発生の失敗

getResult

public PFObjectList getResult()

検索結果リストを取得する。

戻り値:

結果リスト(PFObjectList)

getHitList

public PFObjectList getHitList()

検索時に指定したリスト直下の要素内で、検索にヒットした要素のリストを取得する。

戻り値:

ヒット要素リスト(PFObjectList)

selectHitItem

public void selectHitItem(int i)
                   throws PFException

検索結果リストから指定位置の結果を選択。 データ選択イベントが発生する。 イベント内包データは検索結果のパス(PFObjectList)。

パラメータ:

i - 指定位置インデックス

例外:

PFException - 検索結果リストアクセスの失敗またはイベント処理エラー