SimpleController (PEXA API Document)

java.lang.Object
- pexa.client.std.controller.base.SimpleController

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

Controller
```
public class SimpleController
extends java.lang.Object
implements Controller
```
コントローラの簡易実装クラス

バージョン:

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

作成者:

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

コンストラクタ
コンストラクタと説明
`SimpleController(java.lang.String id, AreaDefinition areaDef, ClientContext context)` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addControllerEventListener(ControllerEventListener l)` イベントリスナーを登録する
`int`	`countProcessingEvent()` 現在処理中のイベントの数を取得する。
`void`	`destroy()` コントローラを終了する
`java.lang.String`	`doCommand(java.lang.String commandID, ClientEvent e)` コマンドを実行する
`protected void`	`fireStateChanged(java.lang.String oldState, java.lang.String newState, ClientEvent cause)` 状態変更イベントを発行する
`Area`	`getArea()` コントローラが制御するAreaインスタンスを取得する
`ClientContext`	`getClientContext()` コントローラが紐尽くClientSessionを取得する
`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)` コマンドを実行し、エラー有無を判定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - SimpleController
```
public SimpleController(java.lang.String id,
                        AreaDefinition areaDef,
                        ClientContext context)
```
    コンストラクタ
    
    パラメータ:
    
    id - コントローラに割り振られるユニークなID
    
    areaDef - エリア定義
    
    context - 実行コンテキスト
- メソッドの詳細
  - getID
```
public java.lang.String getID()
```
    コントローラに割り振られているユニークなIDを取得する
    
    定義:
    
    getID インタフェース内 Controller
    
    戻り値:
    
    コントローラID
  - processEvent
```
public void processEvent(ClientEvent e)
```
    イベントを処理する
    
    定義:
    
    processEvent インタフェース内 Controller
    
    パラメータ:
    
    e - イベント情報オブジェクト
  - doCommand
```
public java.lang.String doCommand(java.lang.String commandID,
                                  ClientEvent e)
                           throws RecoverableException
```
    コマンドを実行する
    
    定義:
    
    doCommand インタフェース内 Controller
    
    パラメータ:
    
    commandID - 実行コマンドのID
    
    e - 実行イベント情報
    
    戻り値:
    
    コマンド終了時に指定された遷移先状態名。指定がない場合はnull。
    
    例外:
    
    RecoverableException - コマンド実行時にエラー発生
  - validateCommand
```
public boolean validateCommand(java.lang.String commandID,
                               ClientEvent e)
```
    コマンドを実行し、エラー有無を判定する。
    
    定義:
    
    validateCommand インタフェース内 Controller
    
    パラメータ:
    
    commandID - 実行コマンドのID
    
    e - 実行イベント情報
    
    戻り値:
    
    エラーなしで実行されればtrue,エラーが発生していればfalse
  - getClientContext
```
public ClientContext getClientContext()
```
    コントローラが紐尽くClientSessionを取得する
    
    定義:
    
    getClientContext インタフェース内 Controller
    
    戻り値:
    
    クライアント実行コンテキスト
  - getArea
```
public Area getArea()
```
    コントローラが制御するAreaインスタンスを取得する
    
    定義:
    
    getArea インタフェース内 Controller
    
    戻り値:
    
    エリアインスタンス
  - installArea
```
public void installArea(Area area)
```
    コントローラが制御するAreaインスタンスを登録する登録は一度しかできない。
    
    定義:
    
    installArea インタフェース内 Controller
    
    パラメータ:
    
    area - エリアインスタンス
    
    例外:
    
    java.lang.IllegalStateException - 設定を二度行った場合
  - installAccessControlPermission
```
public void installAccessControlPermission(ClientEvent e)
                                    throws RecoverableException
```
    実行コマンドに対する権限制御パーミッションをインストールする
    
    定義:
    
    installAccessControlPermission インタフェース内 Controller
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - パーミッション設定に失敗
  - getContent
```
public Content getContent(java.lang.String contentID)
```
    コントローラの制御対象となるコンテントインスタンスを取得する
    
    定義:
    
    getContent インタフェース内 Controller
    
    パラメータ:
    
    contentID - 取得するコンテントのID
    
    戻り値:
    
    コンテントインスタンス
  - destroy
```
public void destroy()
```
    コントローラを終了する
    
    定義:
    
    destroy インタフェース内 Controller
  - getInterpreter
```
public Interpreter getInterpreter()
```
    制御コマンドのインタプリタを取得する
    
    定義:
    
    getInterpreter インタフェース内 Controller
    
    戻り値:
    
    制御コマンドインタプリタ
  - hasEventPermission
```
public boolean hasEventPermission(java.lang.String event)
```
    イベントの実行が可能な状態か判定する
    
    定義:
    
    hasEventPermission インタフェース内 Controller
    
    パラメータ:
    
    event - 実行可能であるかを判定したいイベント名
    
    戻り値:
    
    実行可能ならtrue、実行不可能ならfalse
  - getState
```
public java.lang.String getState()
```
    現在の状態を取得する
    
    定義:
    
    getState インタフェース内 Controller
    
    パラメータ:
    
    現状態 -
  - countProcessingEvent
```
public int countProcessingEvent()
```
    現在処理中のイベントの数を取得する。
    
    定義:
    
    countProcessingEvent インタフェース内 Controller
    
    戻り値:
    
    現在処理中のイベント数。
  - getCurrentProcessingEvent
```
public ClientEvent getCurrentProcessingEvent()
```
    現在処理中のイベントを取得する。
    
    定義:
    
    getCurrentProcessingEvent インタフェース内 Controller
    
    戻り値:
    
    現在処理中のイベント。
  - addControllerEventListener
```
public void addControllerEventListener(ControllerEventListener l)
```
    イベントリスナーを登録する
    
    定義:
    
    addControllerEventListener インタフェース内 Controller
    
    パラメータ:
    
    l - 登録するイベントリスナー
  - getControllerEventListeners
```
public ControllerEventListener[] getControllerEventListeners()
```
    イベントリスナー配列を取得する
    
    定義:
    
    getControllerEventListeners インタフェース内 Controller
    
    戻り値:
    
    イベントリスナーリストの配列
  - removeControllerEventListener
```
public void removeControllerEventListener(ControllerEventListener l)
```
    イベントリスナーを削除する
    
    定義:
    
    removeControllerEventListener インタフェース内 Controller
    
    パラメータ:
    
    l - 削除するイベントリスナー
  - fireStateChanged
```
protected void fireStateChanged(java.lang.String oldState,
                                java.lang.String newState,
                                ClientEvent cause)
```
    状態変更イベントを発行する
    
    パラメータ:
    
    oldState - 遷移前状態
    
    newState - 遷移後状態
    
    cause - 状態変更の原因となったイベント

クラス SimpleController

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

メソッドのサマリー

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

コンストラクタの詳細

SimpleController

メソッドの詳細

getID

processEvent

doCommand

validateCommand

getClientContext

getArea

installArea

installAccessControlPermission

getContent

destroy

getInterpreter

hasEventPermission

getState

countProcessingEvent

getCurrentProcessingEvent

addControllerEventListener

getControllerEventListeners

removeControllerEventListener

fireStateChanged