jp.go.aist.dmrc.platform.beans.util
クラス PFStringFinderForList

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.PFStringFinderForList
すべての実装インタフェース:
PFComponent, PFDataSelectEventSource, PFEventSource, PFProcessTerminateEventSource, PFXMLSerializable, java.io.Serializable

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

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

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

関連項目:
直列化された形式

コンストラクタの概要
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 getComponentString()
          コンポーネントの文字列表現を取得する。
 PFObjectList getHitList()
          検索時に指定したリスト直下の要素内で、検索にヒットした要素のリストを取得する。
 java.util.Iterator getPFDataSelectListenerList()
          データ選択イベントリスナ配列を取得する。
 java.util.Iterator getPFProcessTerminateListenerList()
          処理完了イベントリスナ配列を取得する。
 PFObjectList getResult()
          検索結果リストを取得する。
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFDataSelectListener(PFDataSelectListener lis)
          引数で与えられたイベントリスナを削除し、 データ選択イベント発生時に処理を行う対象から外す。
 void removePFProcessTerminateListener(PFProcessTerminateListener lis)
          引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
 void selectHitItem(int i)
          検索結果リストから指定位置の結果を選択。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントのキー情報を設定する
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 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()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列
関連項目:
PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントのキー情報を設定する

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - 設定するコンポーネントのキー
関連項目:
PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID
関連項目:
PFComponent.getComponentID()

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID
関連項目:
PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
コンポーネントの文字列表現を返す。
関連項目:
PFComponent.getComponentString()

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()
処理完了イベントリスナ配列を取得する。

定義:
インタフェース PFProcessTerminateEventSource 内の getPFProcessTerminateListenerList
戻り値:
イベントリスナイテレータ

addPFProcessTerminateListener

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

定義:
インタフェース PFProcessTerminateEventSource 内の addPFProcessTerminateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFProcessTerminateListener

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

定義:
インタフェース PFProcessTerminateEventSource 内の removePFProcessTerminateListener
パラメータ:
lis - 削除対象イベントリスナ

getPFDataSelectListenerList

public java.util.Iterator getPFDataSelectListenerList()
データ選択イベントリスナ配列を取得する。

定義:
インタフェース PFDataSelectEventSource 内の getPFDataSelectListenerList
戻り値:
イベントリスナイテレータ

addPFDataSelectListener

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

定義:
インタフェース PFDataSelectEventSource 内の addPFDataSelectListener
パラメータ:
lis - 追加対象イベントリスナ

removePFDataSelectListener

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

定義:
インタフェース PFDataSelectEventSource 内の removePFDataSelectListener
パラメータ:
lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
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 - 検索結果リストアクセスの失敗またはイベント処理エラー