de.bensoft.acis.core

Class ACIS.OnExecutionListener

java.lang.Object

de.bensoft.acis.core.ACIS.OnExecutionListener

Enclosing class:

ACIS

public abstract static class ACIS.OnExecutionListener
extends java.lang.Object

Represents a listener for events in the ACIS.executeNewThread(String, float, WeightSet, OnExecutionListener) function.

Constructor Summary

Constructors

Constructor and Description
OnExecutionListener()

Method Summary

Modifier and Type	Method and Description
ActionResult	onActionRun(Action action, Environment environment, Sentence sentence, Parameter[] parameter) Runs the Action's Action.ActionMethod with the given parameters.
MatchResult	onGetBestResult(MatchResult[] results) Called when the best result is about to be selected.
MatchResult[]	onMatcherResult(MatchResult[] results) Called when the matching is completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnExecutionListener

public OnExecutionListener()

Method Detail

onMatcherResult

public MatchResult[] onMatcherResult(MatchResult[] results)

Called when the matching is completed.
By default this sorts the results descending by score.

Parameters:

results - The matching results. May be of length 0;

Returns:

The MatchResult array (Must not be null, empty array instead).

onGetBestResult

public MatchResult onGetBestResult(MatchResult[] results)

Called when the best result is about to be selected.
Note: Do not forget to call super if not doing the MatchResult selection yourself.
By default this returns the element with the highest score.

Parameters:

results - The matching results sorted descending by score. May be of length 0;

Returns:

The MatchResult of which the Action should be executed or null when no best result was found (e.g. in case of a 0-length results array).

onActionRun

public ActionResult onActionRun(Action action,
                                Environment environment,
                                Sentence sentence,
                                Parameter[] parameter)

Runs the Action's Action.ActionMethod with the given parameters.
Note: Do not forget to call super if not running the ActionMethod yourself.
By default this simply calls the Action.ActionMethod.run(Environment, Sentence, Parameter[]) method in a try-catch block.
May return an ActionResult with an ActionResult.ActionResultCode ActionResult.ActionResultCode.INTERNAL_ERROR with the Exception as message.

Parameters:

action - The Action.

environment - The Environment.

sentence - The input Sentence.

parameter - The parsed Parameters.

Returns:

The ActionResult of the execution.