no.g9.client.core.action

Class G9Action<V>

java.lang.Object

no.g9.client.core.action.G9Action<V>

Type Parameters:

V - The target class this action operates on.

All Implemented Interfaces:

Callable<V>

Direct Known Subclasses:

CheckableAction

public class G9Action<V>
extends Object
implements Callable<V>

The base g9 action class.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionTask<V>	actionTask The actual task to perform
protected boolean	CANCELLED Flag - true if action is cancelled.
protected static HookInvoker	hookInvoker The hook invoker

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	G9Action(ActionType actionType, ActionTarget actionTarget, ActionTask<V> actionTask, Class<V> resultClass, ApplicationController applicationController) Constructs a new g9 action
protected	G9Action(ActionType actionType, ActionTarget actionTarget, ActionTask<V> actionTask, Class<V> resultClass, DialogController dialogController) Constructs a new g9 action

Method Summary

Modifier and Type	Method and Description
V	call() Performs the action and invokes hooks.
void	cancel() Cancel the action.
protected void	cleanUpHook() Decouples the relation between this action and the action hook.
protected ActionHookList<V>	getActionHookList() Returns the list of action hooks used by this action.
Object	getActionSetupValue() Get the action setup value.
ActionTarget	getActionTarget() Gets the action target
protected ActionTask<V>	getActionTask() Gets the callable action task of this action
ActionType	getActionType() Returns the action type of this action
ApplicationController	getApplicationController() Gets the application controller that initiated this action
DialogController	getController() Returns the dialog controller that initiated this action
protected List<no.esito.jvine.model.CurrentRoleObject>	getCurrentInstanceList()
DialogController	getDialogController()
EventContext	getEvent() Get the event that triggered this action.
Boolean	getFlag() Get the general purpose FLAG value.
HookInvoker	getHookInvoker()
static no.esito.log.Logger	getLog()
no.esito.jvine.view.MessageUtil	getMessageUtil()
Class<V>	getResultClas()
protected Class<V>	getResultClass() Gets the result class
protected ThreadType	getThreadType(String methodName, Class... params) Utility method, returns the thread type the method is annotated with.
protected boolean	hasHook() Check if this action has an associated hook.
boolean	isCancelled() Check if this action is cancelled.
protected boolean	isInvokeHooksOn() Test whether hooks are turned on or off.
protected void	setActionHookList(ActionHookList<V> actionHookList) Sets the list of action hooks to be used by this action.
void	setActionSetupValue(Object setupValue) Set the action setup value.
void	setEvent(EventContext event) Set the event that triggered this action.
void	setFlag(Boolean flagValue) Set a general purpose flag.
static void	setLog(no.esito.log.Logger log)
protected boolean	shouldInvokeHook() Test if hook should be invoked.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

hookInvoker

protected static final HookInvoker hookInvoker

The hook invoker

actionTask

protected ActionTask<V> actionTask

The actual task to perform

CANCELLED

protected volatile boolean CANCELLED

Flag - true if action is cancelled.

Constructor Detail

G9Action

protected G9Action(ActionType actionType,
                   ActionTarget actionTarget,
                   ActionTask<V> actionTask,
                   Class<V> resultClass,
                   DialogController dialogController)

Constructs a new g9 action

Parameters:

actionType - the action type

actionTarget - the action target

actionTask - the callable implementing the action task

resultClass - the target class

dialogController - the dialog controller that initiated this action

G9Action

protected G9Action(ActionType actionType,
                   ActionTarget actionTarget,
                   ActionTask<V> actionTask,
                   Class<V> resultClass,
                   ApplicationController applicationController)

Constructs a new g9 action

Parameters:

actionType - the action type

actionTarget - the action target

actionTask - the callable implementing the action task

resultClass - the target class

applicationController - the dialog controller that initiated this action

Method Detail

getMessageUtil

public no.esito.jvine.view.MessageUtil getMessageUtil()

Returns:

MessageUtil

getFlag

public Boolean getFlag()

Get the general purpose FLAG value.

Returns:

the flag value

See Also:

getFlag()

setFlag

public void setFlag(Boolean flagValue)

Set a general purpose flag. This flag is used by the following actions:

• OPEN - if set to true, the action will attempt to always open a new dialog.

Parameters:

flagValue - the value of the flag.

getEvent

public EventContext getEvent()

Get the event that triggered this action.

Returns:

the triggering event

setEvent

public void setEvent(EventContext event)

Set the event that triggered this action.

Parameters:

event - the triggering event

getHookInvoker

public HookInvoker getHookInvoker()

Returns:

HookInvoker

getLog

public static no.esito.log.Logger getLog()

Returns:

Logger

setLog

public static void setLog(no.esito.log.Logger log)

Parameters:

log - Logger

getResultClas

public Class<V> getResultClas()

Returns:

resultClass

getDialogController

public DialogController getDialogController()

Returns:

DialogController

isInvokeHooksOn

protected final boolean isInvokeHooksOn()

Test whether hooks are turned on or off.

Returns:

true if the hook mechanism is turned on.

getController

public final DialogController getController()

Returns the dialog controller that initiated this action

Returns:

the dialog controller this action "belongs" to.

getApplicationController

public final ApplicationController getApplicationController()

Gets the application controller that initiated this action

Returns:

the application controller this action "belongs" to.

getActionTask

protected ActionTask<V> getActionTask()

Gets the callable action task of this action

Returns:

the action task

isCancelled

public boolean isCancelled()

Check if this action is cancelled.

Synchronizes on "this".

Returns:

true if this action is cancelled

cancel

public void cancel()

Cancel the action.

Synchronizes on "this".

getActionSetupValue

public Object getActionSetupValue()

Get the action setup value.

Returns:

action setup value

See Also:

setActionSetupValue(Object)

setActionSetupValue

public void setActionSetupValue(Object setupValue)

Set the action setup value. The action setup value will be used as a parameter for actions that support parameters.

Note: Although the type of the value parameter is Object one must make sure that the actual type matches the expected parameter type; e.g. for the Open action, the parameter type is no.g9.client.core.controller.DialogSetupValue.

Parameters:

setupValue - the action setup parameter

getCurrentInstanceList

protected List<no.esito.jvine.model.CurrentRoleObject> getCurrentInstanceList()

Returns:

currentInstanceList

call

public V call()
       throws Exception

Performs the action and invokes hooks. After the hook as finished the registered hook is removed, and the connection from the hook to this action is removed.

Specified by:

call in interface Callable<V>

Returns:

the result of performing this action.

Throws:

Exception

cleanUpHook

protected void cleanUpHook()
                    throws InterruptedException

Decouples the relation between this action and the action hook. This method blocks until the action execution has finished.

Throws:

InterruptedException - if interrupted while waiting for the action to finish.

getActionTarget

public ActionTarget getActionTarget()

Gets the action target

Returns:

the enumeration denoting the target

getActionHookList

protected ActionHookList<V> getActionHookList()

Returns the list of action hooks used by this action.

Returns:

the action hook list

setActionHookList

protected void setActionHookList(ActionHookList<V> actionHookList)

Sets the list of action hooks to be used by this action.

Parameters:

actionHookList - the action hook list of this action

getThreadType

protected ThreadType getThreadType(String methodName,
                                   Class... params)

Utility method, returns the thread type the method is annotated with.

Parameters:

methodName - the declared method name

params - the method parameters

Returns:

the thread type for a the specified hook method

hasHook

protected boolean hasHook()

Check if this action has an associated hook.

Returns:

true if this action has a registered hook.

shouldInvokeHook

protected boolean shouldInvokeHook()

Test if hook should be invoked. This method tests that:

1. The hook mechanism is turned on.
2. This action has a registered hook

If both conditions are true, hooks should be invoked.

Returns:

true if hooks should be invoked.

toString

public String toString()

Overrides:

toString in class Object

getActionType

public ActionType getActionType()

Returns the action type of this action

Returns:

the action type of this action

getResultClass

protected Class<V> getResultClass()

Gets the result class

Returns:

the result class