no.g9.client.core.controller

Class ApplicationController

java.lang.Object

no.esito.jvine.controller.JVineApplicationController

no.g9.client.core.controller.ApplicationController

All Implemented Interfaces:

no.esito.jvine.communication.SystemMessagePipe

public abstract class ApplicationController
extends no.esito.jvine.controller.JVineApplicationController
implements no.esito.jvine.communication.SystemMessagePipe

The application controller. Controls various aspects of the application.

Constructor Summary

Constructors

Constructor and Description
ApplicationController(String applicationName) Constructs a new application controller

Method Summary

Modifier and Type	Method and Description
String	addCallBack(DialogController actionInvoker, DialogConstant callee, CallBack callBack) Add the given call back to the map of pending call backs for this application.
boolean	closeDialogInstance(DialogInstance dialogInstance) Close dialog instance identified by the dialogInstance key.
DialogInstance	createDialogInstance(DialogConstant dialogConstant, int instanceNumber) Creates a new dialog instance and pushes it on top of the stack.
void	forward(String codedMessage) Forward a message towards the receiver.
void	forward(SystemMessage decodedMessage) Forward a message towards the receiver.
protected void	forwardToDialog(SystemMessage decodedMessage, DialogConstant dialogConstant) Try forwarding a message to a dialog.
protected void	forwardToExternal(SystemMessage decodedMessage) Forward a message towards an external receiver.
protected ActionHookList<?>	getActionHookList(ActionTarget actionTarget, ActionType actionType) Get the specified action hooks.
List<DialogInstance>	getActiveDialogInstances(DialogConstant dialogConstant) Gets a list of active dialog instances.
abstract <T extends DialogConstant> T	getApplicationDialogConstant() Return the dialog constant of the application window.
String	getApplicationId() Gets the application ID.
String	getApplicationName() Gets the application name
ApplicationView	getApplicationView() Gets the application's view.
ClientContext	getClientContext() Returns the client context
static ApplicationController	getCurrentApplicationController() Get the current application controller for this thread.
DialogInstance	getCurrentDialogInstance(DialogConstant dialogConstant) Gets the current instance number, i.e.
<T extends DialogConstant> T	getDialogConst(String dialogInternalName) Get the dialog constant for the specified dialog.
<T extends DialogController> T	getDialogController(DialogConstant dialogConstant) Get the current dialog controller for the specified dialog.
<T extends DialogController> T	getDialogController(DialogInstance dialogInstance) Gets the dialog controller identified by the dialog instance key.
protected DialogInstanceManager	getDialogInstanceManager() Getter
<T extends DialogView> T	getDialogView(DialogConstant dialogConstant) Gets the specified dialog view.
CallBack	getExternalCallBack(SystemMessage callBackMessage) Get a CallBack object which will forward the call back value to the given receiver/port.
List<DialogInstance>	getOpenDialogInstanceList(DialogConstant dialogConstant) Get a list of open dialog instances, ordered by when the instance was created (oldest first).
List<DialogController>	getOpenDialogs() Get a list of dialog controllers for all open dialogs.
JGrapeService	getServiceProxy() Returns the jgrape service
ViewModel	getViewModel(DialogConstant dialog) Get the ViewModel for the given dialog.
void	handleCommunicationError(CommunicationError commErr) This method is called when there was a problem sending a message to an external application.
boolean	hasAvailableDialogInstance(DialogConstant dialogConstant) Checks for available dialog instance.
void	invokeOnGui(Runnable task) Invokes the specified task on the gui thread.
void	performAction(ActionType action, DialogConstant target) Performs the specified action.
void	performAction(ActionType action, DialogConstant target, boolean flag) Performs the specified action.
void	performActionFromExternal(ActionType action, DialogConstant target, boolean flag) Performs the specified action.
void	registerController(int instanceNumber, DialogController newController) Registers the controller. Warning: this method should not be used by developers.
void	registerHook(ActionTarget actionTarget, ActionType actionType, ActionHook<?> hook) Register the specified action hook
void	removeDialogInstance(DialogInstance dialogInstance) Removes the dialog instance identified by the instance key from the stack.
DialogController	setActiveDialogInstance(DialogInstance dialogInstanceKey) Sets the active dialog instance.
void	setApplicationView(ApplicationView applicationView) Sets the application's view.

Methods inherited from class no.esito.jvine.controller.JVineApplicationController

setCurrentApplicationController, setSaveCurrentAppController

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationController

public ApplicationController(String applicationName)

Constructs a new application controller

Parameters:

applicationName - the name of the application controller.

Method Detail

getDialogInstanceManager

protected DialogInstanceManager getDialogInstanceManager()

Getter

Returns:

the DialogInstanceManager

getDialogConst

public final <T extends DialogConstant> T getDialogConst(String dialogInternalName)

Get the dialog constant for the specified dialog.

Type Parameters:

T - The expected dialog controller type.

Parameters:

dialogInternalName - the dialog name as it is defined in the bean id.

Returns:

the dialog constant.

Throws:

ClassCastException - if the returned type does not match the expected type.

getCurrentDialogInstance

public final DialogInstance getCurrentDialogInstance(DialogConstant dialogConstant)

Gets the current instance number, i.e. the dialog on top of the stack.

Parameters:

dialogConstant - the dialog constant

Returns:

the current instance number, null if no active dialog found for this dialog constant

setActiveDialogInstance

public final DialogController setActiveDialogInstance(DialogInstance dialogInstanceKey)

Sets the active dialog instance.

Parameters:

dialogInstanceKey - the key identifying the dialog instance

Returns:

the dialog controller identified by the dialogInstanceKey, null if no instance found with the given id

removeDialogInstance

public void removeDialogInstance(DialogInstance dialogInstance)

Removes the dialog instance identified by the instance key from the stack. WARNING: Although this method is public, it should not be treated as part of the public API, as it might change in incompatible ways between releases (even patches).

Use closeDialogInstance(DialogInstance) to close a dialog.

Parameters:

dialogInstance - the dialog instance key of the dialog to remove.

closeDialogInstance

public boolean closeDialogInstance(DialogInstance dialogInstance)

Close dialog instance identified by the dialogInstance key.

Parameters:

dialogInstance - the dialog instance to close

Returns:

true, if successful

hasAvailableDialogInstance

public boolean hasAvailableDialogInstance(DialogConstant dialogConstant)

Checks for available dialog instance.

Parameters:

dialogConstant - the dialog constant

Returns:

true if there is one or more available dialog instances for the given dialog

getActiveDialogInstances

public List<DialogInstance> getActiveDialogInstances(DialogConstant dialogConstant)

Gets a list of active dialog instances.

Parameters:

dialogConstant - the dialog constant identifying the dialog

Returns:

the list of active dialog instances, an empty list if no active dialogs of this type

getOpenDialogInstanceList

public List<DialogInstance> getOpenDialogInstanceList(DialogConstant dialogConstant)

Get a list of open dialog instances, ordered by when the instance was created (oldest first).

Parameters:

dialogConstant - constant identifying the dialog

Returns:

list of open dialog instances or empty list if no instances is opened

getOpenDialogs

public List<DialogController> getOpenDialogs()

Get a list of dialog controllers for all open dialogs.

Returns:

list of all open dialog controllers

registerController

public void registerController(int instanceNumber,
                               DialogController newController)

Registers the controller.
Warning: this method should not be used by developers.

Parameters:

instanceNumber - instance number

newController - controller

getDialogController

public final <T extends DialogController> T getDialogController(DialogConstant dialogConstant)

Get the current dialog controller for the specified dialog.

Type Parameters:

T - The expected dialog controller type

Parameters:

dialogConstant - the dialog constant denoting the dialog controller.

Returns:

the cached or a new dialog controller

Throws:

ClassCastException - if the returned type does not match the expected dialog controller type.

getDialogController

public final <T extends DialogController> T getDialogController(DialogInstance dialogInstance)

Gets the dialog controller identified by the dialog instance key. This method does nothing with the internal stack. WARNING: Although this method is public, it should not be treated as part of the public API, as it might change in incompatible ways between releases (even patches).

Type Parameters:

T - the generic type of the controller.

Parameters:

dialogInstance - the dialog instance

Returns:

the dialog controller, null if not found.

createDialogInstance

public DialogInstance createDialogInstance(DialogConstant dialogConstant,
                                           int instanceNumber)

Creates a new dialog instance and pushes it on top of the stack. WARNING: Although this method is public, it should not be treated as part of the public API, as it might change in incompatible ways between releases (even patches).

Parameters:

dialogConstant - the dialog constant

instanceNumber - the instance number, set to -1 to get the next available instanceNumber

Returns:

the dialog instance

Throws:

InstanceNumberOutOfBoundsException - when no more dialogs of this dialog can be created.

IllegalStateException - when instanceNumber refers to an instance that already exists

getApplicationName

public String getApplicationName()

Gets the application name

Returns:

the application name

getApplicationId

public String getApplicationId()

Gets the application ID. The application ID is the same as the application name, with a lower case first letter.

Returns:

the application ID

getClientContext

public ClientContext getClientContext()

Returns the client context

Returns:

the client context

getServiceProxy

public JGrapeService getServiceProxy()

Returns the jgrape service

Returns:

the jgrape service proxy

getApplicationView

public final ApplicationView getApplicationView()

Gets the application's view.

Returns:

the application view.

getDialogView

public final <T extends DialogView> T getDialogView(DialogConstant dialogConstant)

Gets the specified dialog view.

Type Parameters:

T - the dialog view type

Parameters:

dialogConstant - the (generated) constant denoting the dialog.

Returns:

the dialog view.

setApplicationView

public final void setApplicationView(ApplicationView applicationView)

Sets the application's view.

Parameters:

applicationView - the application view.

performAction

public final void performAction(ActionType action,
                                DialogConstant target,
                                boolean flag)

Performs the specified action.

Parameters:

action - the action to perform.

target - the target of the action.

flag - a general purpose flag

performActionFromExternal

public final void performActionFromExternal(ActionType action,
                                            DialogConstant target,
                                            boolean flag)

Performs the specified action. The action was initiated from an external source.

Parameters:

action - the action to perform.

target - the target of the action.

flag - a general purpose flag

performAction

public final void performAction(ActionType action,
                                DialogConstant target)

Performs the specified action.

Parameters:

action - the action to perform.

target - the target of the action.

registerHook

public final void registerHook(ActionTarget actionTarget,
                               ActionType actionType,
                               ActionHook<?> hook)

Register the specified action hook

Parameters:

actionTarget - the action target

actionType - the action type

hook - the action hook that should be invoked when the action runs.

getActionHookList

protected final ActionHookList<?> getActionHookList(ActionTarget actionTarget,
                                                    ActionType actionType)

Get the specified action hooks.

Parameters:

actionTarget - the action target

actionType - the action type

Returns:

the list of hooks registered with the specified action and target.

getViewModel

public final ViewModel getViewModel(DialogConstant dialog)

Get the ViewModel for the given dialog.

Parameters:

dialog - the dialog which "owns" the ViewModel.

Returns:

the ViewModel for the given dialog.

See Also:

ApplicationView.getViewModel(DialogConstant)

invokeOnGui

public final void invokeOnGui(Runnable task)
                       throws InvocationTargetException

Invokes the specified task on the gui thread. If the invoking thread is a worker thread, the runnable is put on the GUI executing queue. Otherwise (the invoking thread is a GUI thread), the Runnable's run method is simply invoked as is.

Parameters:

task - the task to perform.

Throws:

InvocationTargetException - exceptions that occurred during invocation of the runnable are wrapped and re-thrown.

getApplicationDialogConstant

public abstract <T extends DialogConstant> T getApplicationDialogConstant()

Return the dialog constant of the application window.

Type Parameters:

T - the actual type of the dialog constant.

Returns:

the dialog constant representing the application window.

forward

public void forward(String codedMessage)

Forward a message towards the receiver. If the receiver is this application, locate a handler to receive the message.

Parameters:

codedMessage - The coded message

forward

public void forward(SystemMessage decodedMessage)

Forward a message towards the receiver. If the receiver is this application, locate a handler to receive the message.

Specified by:

forward in interface no.esito.jvine.communication.SystemMessagePipe

Parameters:

decodedMessage - The decoded message

handleCommunicationError

public void handleCommunicationError(CommunicationError commErr)

This method is called when there was a problem sending a message to an external application. Override this method in a subclass if you want to do more than logging the error.

Parameters:

commErr - an object containing error information

addCallBack

public String addCallBack(DialogController actionInvoker,
                          DialogConstant callee,
                          CallBack callBack)

Add the given call back to the map of pending call backs for this application. The map key for the call back is returned. Note: For internal use only!

Parameters:

actionInvoker - the dialog which invoked the action

callee - the dialog which is the action target

callBack - the call back

Returns:

the map key

getExternalCallBack

public CallBack getExternalCallBack(SystemMessage callBackMessage)

Get a CallBack object which will forward the call back value to the given receiver/port.

Parameters:

callBackMessage - the return port message

Returns:

the CallBack object

forwardToDialog

protected void forwardToDialog(SystemMessage decodedMessage,
                               DialogConstant dialogConstant)

Try forwarding a message to a dialog.

Parameters:

decodedMessage - the message to forward

dialogConstant - the receiving dialog

forwardToExternal

protected void forwardToExternal(SystemMessage decodedMessage)

Forward a message towards an external receiver. The next link in the chain is the applicationDialog.

Parameters:

decodedMessage - the message to forward

getCurrentApplicationController

public static final ApplicationController getCurrentApplicationController()

Get the current application controller for this thread.

Returns:

the current application controller