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

java.lang.Object
  jp.go.aist.dmrc.platform.beans.util.PFObjectQueue

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

PFComponent, PFDataSetEventSource, PFEventSource, PFXMLSerializable, java.io.Serializable

public class PFObjectQueue

extends java.lang.Object

implements PFComponent, PFDataSetEventSource, PFXMLSerializable

オブジェクトキューコンポーネント
　このコンポーネントはオブジェクトのキュー機能を提供します。

コンポーネントから発生するイベント

• データ設定イベント
  

  トリガ	対象データ	イベント番号
  setQueue()の呼び出しによる キューの設定	設定されたキュー PFObjectList	2
  push()の呼び出しによる オブジェクトの格納	格納されたオブジェクト	1
  clear()の呼び出しによる キューの消去	消去されたキュー PFObjectList	0
  pop()の呼び出しによる オブジェクトの取り出し	取り出されたオブジェクト	-1

関連項目:

直列化された形式

フィールドの概要

static int	CLEAR キュー消去時のデータ設定イベント番号
static int	POP オブジェクト取出時のデータ設定イベント番号
static int	PUSH オブジェクト格納時のデータ設定イベント番号
static int	SET_QUEUE キュー設定時のデータ設定イベント番号

コンストラクタの概要

PFObjectQueue()
コンストラクタ

メソッドの概要

void	addPFDataSetListener(PFDataSetListener lis) 引数で与えられたイベントリスナを登録し、 データ設定イベント発生時に処理を行う対象とする。
void	backward(int index) インデックスで指定されたオブジェクトの順序を１つ後に移動する。
void	clear() キューを消去する。
void	forward(int index) インデックスで指定されたオブジェクトの順序を１つ前に移動する。
java.lang.Object	get(int index) インデックスで指定されたオブジェクトを、キューから削除することなく 取得する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
java.util.Iterator	getPFDataSetListenerList() データ設定イベントリスナ配列を取得する。
PFObjectList	getQueue() キューの実体を取得する。
java.lang.Object[]	getQueueArray() キューを配列として取得する。
PFObjectList	getQueueList() キューのリスト（クローン）を取得する。
java.lang.Object	getSelectedObject() 選択されたオブジェクトを、キューから削除することなく取得する。
PFObjectList	getSortedList() キューをソートしたリストを取得する。
boolean	insert(java.lang.Object obj, int index) インデックスで指定された位置にオブジェクトを挿入する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isEmpty() キューが空かどうかを調べる。
void	localeUpdated() ロケール変更に対応する。
java.lang.Object	peek() オブジェクトをキューから 削除することなく取得する。
java.lang.Object	pop() オブジェクトを取り出す。
void	push(java.lang.Object obj) オブジェクトを格納する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
java.lang.Object	remove(int index) インデックスで指定されたオブジェクトを、キューから削除する。
void	removePFDataSetListener(PFDataSetListener lis) 引数で与えられたイベントリスナを削除し、 データ設定イベント発生時に処理を行う対象から外す。
void	select(int index) インデックスで指定されたオブジェクトを、キューから削除することなく 選択する。
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	setQueue(java.lang.Object queue) キューを設定する。
void	setQueue(java.lang.Object[] queue) キューを設定する。
void	setQueue(PFObjectList queue) キューを設定する。
int	size() サイズ（オブジェクト数）を取得する。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

フィールドの詳細

SET_QUEUE

public static final int SET_QUEUE

キュー設定時のデータ設定イベント番号

関連項目:

定数フィールド値

PUSH

public static final int PUSH

オブジェクト格納時のデータ設定イベント番号

関連項目:

定数フィールド値

CLEAR

public static final int CLEAR

キュー消去時のデータ設定イベント番号

関連項目:

定数フィールド値

POP

public static final int POP

オブジェクト取出時のデータ設定イベント番号

関連項目:

定数フィールド値

コンストラクタの詳細

PFObjectQueue

public PFObjectQueue()

コンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

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

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

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

定義:

インタフェース PFComponent 内の getComponentKey

戻り値:

コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

インタフェース PFComponent 内の setComponentKey

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

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

戻り値:

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

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

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

パラメータ:

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

getComponentID

public int getComponentID()

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

定義:

インタフェース PFComponent 内の getComponentID

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

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

定義:

インタフェース PFComponent 内の setComponentID

パラメータ:

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

getComponentString

public java.lang.String getComponentString()

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

定義:

インタフェース PFComponent 内の getComponentString

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

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

定義:

インタフェース PFComponent 内の getComponentPublicName

戻り値:

コンポーネント公開名

setComponentPublicName

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

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

定義:

インタフェース PFComponent 内の setComponentPublicName

パラメータ:

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

例外:

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

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

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

定義:

インタフェース PFComponent 内の isAllowRemoteInvocation

戻り値:

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

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

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

定義:

インタフェース PFComponent 内の setAllowRemoteInvocation

パラメータ:

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

isAllowPullTransfer

public boolean isAllowPullTransfer()

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

定義:

インタフェース PFComponent 内の isAllowPullTransfer

戻り値:

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

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

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

定義:

インタフェース PFComponent 内の setAllowPullTransfer

パラメータ:

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

isAllowPushTransfer

public boolean isAllowPushTransfer()

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

定義:

インタフェース PFComponent 内の isAllowPushTransfer

戻り値:

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

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

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

定義:

インタフェース PFComponent 内の setAllowPushTransfer

パラメータ:

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

getPFDataSetListenerList

public java.util.Iterator getPFDataSetListenerList()

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

定義:

インタフェース PFDataSetEventSource 内の getPFDataSetListenerList

戻り値:

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

addPFDataSetListener

public void addPFDataSetListener(PFDataSetListener lis)

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

定義:

インタフェース PFDataSetEventSource 内の addPFDataSetListener

パラメータ:

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

removePFDataSetListener

public void removePFDataSetListener(PFDataSetListener lis)

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

定義:

インタフェース PFDataSetEventSource 内の removePFDataSetListener

パラメータ:

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

localeUpdated

public void 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

getSortedList

public PFObjectList getSortedList()

キューをソートしたリストを取得する。 ソート結果は、java.util.Collections.sort() による。

戻り値:

キューをソートしたリスト

size

public int size()

サイズ（オブジェクト数）を取得する。

戻り値:

サイズ

forward

public void forward(int index)

インデックスで指定されたオブジェクトの順序を１つ前に移動する。 インデックスは、poly()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

index - インデックス

backward

public void backward(int index)

インデックスで指定されたオブジェクトの順序を１つ後に移動する。 インデックスは、poly()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

index - インデックス

get

public java.lang.Object get(int index)

インデックスで指定されたオブジェクトを、キューから削除することなく 取得する。インデックスは、poly()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

index - インデックス

戻り値:

オブジェクト

select

public void select(int index)

インデックスで指定されたオブジェクトを、キューから削除することなく 選択する。インデックスは、pop()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

index - インデックス

getSelectedObject

public java.lang.Object getSelectedObject()

選択されたオブジェクトを、キューから削除することなく取得する。

戻り値:

選択されたオブジェクト

remove

public java.lang.Object remove(int index)

インデックスで指定されたオブジェクトを、キューから削除する。 インデックスは、poly()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

index - インデックス

戻り値:

削除されたオブジェクト

insert

public boolean insert(java.lang.Object obj,
                      int index)

インデックスで指定された位置にオブジェクトを挿入する。 インデックスは、poly()で取得されるオブジェクトの インデックスを0として数える。

パラメータ:

obj - オブジェクト

index - インデックス

戻り値:

インデックスが適切だった場合true

clear

public void clear()
           throws PFSystemException

キューを消去する。

例外:

PFSystemException

setQueue

public void setQueue(PFObjectList queue)
              throws PFSystemException

キューを設定する。それまでのキューは消去される。

パラメータ:

queue - キュー

例外:

PFSystemException

setQueue

public void setQueue(java.lang.Object[] queue)
              throws PFSystemException

キューを設定する。それまでのキューは消去される。

パラメータ:

queue - キュー

例外:

PFSystemException

setQueue

public void setQueue(java.lang.Object queue)
              throws PFSystemException

キューを設定する。それまでのキューは消去される。 このメソッドは、基本データ型の配列に基づいてキューを設定するために 使われる。

パラメータ:

queue - キュー

例外:

PFSystemException

getQueue

public PFObjectList getQueue()

キューの実体を取得する。

戻り値:

キュー

getQueueList

public PFObjectList getQueueList()

キューのリスト（クローン）を取得する。

戻り値:

キューのリスト

getQueueArray

public java.lang.Object[] getQueueArray()

キューを配列として取得する。

戻り値:

キューの配列

push

public void push(java.lang.Object obj)
          throws PFSystemException

オブジェクトを格納する。

パラメータ:

obj - 格納するオブジェクト

例外:

PFSystemException

pop

public java.lang.Object pop()
                     throws PFSystemException

オブジェクトを取り出す。 スタック内にオブジェクトが存在しない場合には null を返す。

戻り値:

トップのオブジェクト

例外:

PFSystemException

peek

public java.lang.Object peek()

オブジェクトをキューから 削除することなく取得する。

戻り値:

トップのオブジェクト

isEmpty

public boolean isEmpty()

キューが空かどうかを調べる。

戻り値:

キューが空の場合 true。空でない場合 false。