de.bensoft.acis.core

Class Action

java.lang.Object

de.bensoft.acis.core.Action

Direct Known Subclasses:

ContextConstructorAction, ContextDependentAction

public class Action
extends java.lang.Object

Represents a Action for the ACIS system. Actions are the key part of the system as they provide functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Action.ActionMethod This interface includes the run() function which contains the core code of the Action.

Constructor Summary

Constructors

Constructor and Description
Action(java.lang.String actionName, ActionPackage pack, ContextVisibility contextVisibility, java.lang.String trigger, Action.ActionMethod method) Creates a new Action Object.

Method Summary

Modifier and Type	Method and Description
Action.ActionMethod	getActionMethod() A function which returns the Action.ActionMethod.
ActionParameter[]	getActionParams() A function which returns the parameters declared in the Action's trigger.
static Action[]	getActions(java.lang.String actionName, ActionPackage pack, ContextVisibility contextVisibility, java.lang.String[] triggers, Action.ActionMethod method) Creates multiple Actions with same properties but different triggers.
ContextVisibility	getContextVisibility() A function which returns the ContextVisibility of the Action.
java.lang.String	getName() A function which returns the name of the Action.
ActionPackage	getPackage() A function which returns the ActionPackage the Action belongs to.
java.lang.String	getTrigger() A function which returns the trigger of the Action.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action(java.lang.String actionName,
              ActionPackage pack,
              ContextVisibility contextVisibility,
              java.lang.String trigger,
              Action.ActionMethod method)
       throws ActionMalformedException

Creates a new Action Object. In the trigger parameters are allowed to directly gather certain parts of the user input. Parameters are declared like in the following example: "say hello to <<p$0>> and <<p$1>>". Syntax: <<PARAMETERTYPE$INDEX>> Note: The parameter type currently has no effect, so any expression is allowed here (see ParameterType). The index specifies the order the parameters are given back in the Action.ActionMethod (should start at 0 counting up). When the same index occurs more than once or the specified parameter type does not exist the Action is considered as malformed and an ActionMalformedException is thrown.

Parameters:

actionName - The name of the Action.
Format: <NAME>$<ITERATION>, while iteration is used for e.g. multiple triggers.

pack - The ActionPackage the Action belongs to.

contextVisibility - The ContextVisibility.

trigger - The trigger keyphrase.

method - The Action.ActionMethod containing the core functionality of the Action.

Throws:

ActionMalformedException - When the trigger is malformed.

Method Detail

getActions

public static Action[] getActions(java.lang.String actionName,
                                  ActionPackage pack,
                                  ContextVisibility contextVisibility,
                                  java.lang.String[] triggers,
                                  Action.ActionMethod method)
                           throws ActionMalformedException

Creates multiple Actions with same properties but different triggers.
This calls Action(String, ActionPackage, ContextVisibility, String, ActionMethod) for each trigger.

Parameters:

actionName - The name of the Actions.

pack - The ActionPackage the Actions belong to.

contextVisibility - The ContextVisibility.

triggers - Multiple trigger keyphrases.

method - The Action.ActionMethod containing the core functionality of the Action.

Returns:

An array including the created Actions.

Throws:

ActionMalformedException - When one or more triggers are malformed.

See Also:

Action(String, ActionPackage, ContextVisibility, String, ActionMethod)

getName

public java.lang.String getName()

A function which returns the name of the Action.

Returns:

The name.

getPackage

public ActionPackage getPackage()

A function which returns the ActionPackage the Action belongs to.

Returns:

The ActionPackage.

getContextVisibility

public ContextVisibility getContextVisibility()

A function which returns the ContextVisibility of the Action.

Returns:

The context visibility.

getActionMethod

public Action.ActionMethod getActionMethod()

A function which returns the Action.ActionMethod.

Returns:

The ActionMethod.

getActionParams

public ActionParameter[] getActionParams()

A function which returns the parameters declared in the Action's trigger.

Returns:

The ActionParameter array.

getTrigger

public java.lang.String getTrigger()

A function which returns the trigger of the Action.

Returns:

The trigger String including the parameters declaration.