pexa.client.std.controller

インタフェース Controller

既知の実装クラスのリスト:

SimpleController

public interface Controller

クライアントコントローラが実装すべきインタフェース。

バージョン:

$Revision: 5450 $ $Date:: 2010-10-07 18:48:40 #$

作成者:

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addControllerEventListener(ControllerEventListener l) イベントリスナーを登録する
int	countProcessingEvent() 現在処理中のイベントの数を取得する。
void	destroy() コントローラを終了する
java.lang.String	doCommand(java.lang.String commandID, ClientEvent e) コマンドを実行する
Area	getArea() コントローラが制御するAreaインスタンスを取得する
ClientContext	getClientContext() コントローラが紐尽く実行コンテキストを取得する
Content	getContent(java.lang.String contentID) コントローラの制御対象となるコンテントインスタンスを取得する
ControllerEventListener[]	getControllerEventListeners() イベントリスナー配列を取得する
ClientEvent	getCurrentProcessingEvent() 現在処理中のイベントを取得する。
java.lang.String	getID() コントローラに割り振られているユニークなIDを取得する
Interpreter	getInterpreter() 制御コマンドのインタプリタを取得する
java.lang.String	getState() 現在の状態を取得する
boolean	hasEventPermission(java.lang.String event) イベントの実行が可能な状態か判定する
void	installAccessControlPermission(ClientEvent e) 実行コマンドに対する権限制御パーミッションをインストールする
void	installArea(Area area) コントローラが制御するAreaインスタンスを登録する 登録は一度しかできない。
void	processEvent(ClientEvent e) イベントを処理する
void	removeControllerEventListener(ControllerEventListener l) イベントリスナーを削除する
boolean	validateCommand(java.lang.String commandID, ClientEvent e) コマンドを実行し、エラー有無を判定する。

メソッドの詳細

getID

java.lang.String getID()

コントローラに割り振られているユニークなIDを取得する

戻り値:

コントローラID

processEvent

void processEvent(ClientEvent e)

イベントを処理する

パラメータ:

e - イベント情報オブジェクト

doCommand

java.lang.String doCommand(java.lang.String commandID,
                           ClientEvent e)
                    throws RecoverableException

コマンドを実行する

パラメータ:

commandID - 実行コマンドのID

e - 実行イベント情報

戻り値:

コマンド終了時に指定された遷移先状態名。指定がない場合はnull。

例外:

RecoverableException - コマンド実行時にエラー発生

validateCommand

boolean validateCommand(java.lang.String commandID,
                        ClientEvent e)

コマンドを実行し、エラー有無を判定する。

パラメータ:

commandID - 実行コマンドのID

e - 実行イベント情報

戻り値:

エラーなしで実行されればtrue,エラーが発生していればfalse

getClientContext

ClientContext getClientContext()

コントローラが紐尽く実行コンテキストを取得する

戻り値:

クライアント実行コンテキスト

getArea

Area getArea()

コントローラが制御するAreaインスタンスを取得する

戻り値:

エリアインスタンス

installArea

void installArea(Area area)

コントローラが制御するAreaインスタンスを登録する 登録は一度しかできない。

パラメータ:

area - エリアインスタンス

例外:

java.lang.IllegalStateException - 設定を二度行った場合

installAccessControlPermission

void installAccessControlPermission(ClientEvent e)
                             throws RecoverableException

実行コマンドに対する権限制御パーミッションをインストールする

パラメータ:

e - イベント情報

例外:

RecoverableException - パーミッション設定に失敗

getContent

Content getContent(java.lang.String contentID)

コントローラの制御対象となるコンテントインスタンスを取得する

パラメータ:

contentID - 取得するコンテントのID

戻り値:

コンテントインスタンス

getInterpreter

Interpreter getInterpreter()

制御コマンドのインタプリタを取得する

戻り値:

制御コマンドインタプリタ

destroy

void destroy()

コントローラを終了する

hasEventPermission

boolean hasEventPermission(java.lang.String event)

イベントの実行が可能な状態か判定する

パラメータ:

event - 実行可能であるかを判定したいイベント名

戻り値:

実行可能ならtrue、実行不可能ならfalse

getState

java.lang.String getState()

現在の状態を取得する

パラメータ:

現状態 -

countProcessingEvent

int countProcessingEvent()

現在処理中のイベントの数を取得する。

戻り値:

現在処理中のイベント数。

getCurrentProcessingEvent

ClientEvent getCurrentProcessingEvent()

現在処理中のイベントを取得する。

戻り値:

現在処理中のイベント。

addControllerEventListener

void addControllerEventListener(ControllerEventListener l)

イベントリスナーを登録する

パラメータ:

l - 登録するイベントリスナー

getControllerEventListeners

ControllerEventListener[] getControllerEventListeners()

イベントリスナー配列を取得する

戻り値:

イベントリスナーリストの配列

removeControllerEventListener

void removeControllerEventListener(ControllerEventListener l)

イベントリスナーを削除する

パラメータ:

l - 削除するイベントリスナー