A B C D E G H I J N P R S T U W

A

AbstractAction<Input,Output> - Class in ch.maxant.rules

This is an abstract implementation of the IAction interface.

AbstractAction(String) - Constructor for class ch.maxant.rules.AbstractAction

B

build() - Method in class ch.maxant.rules.JavascriptEngine.Builder

Builder(Collection<Rule>) - Constructor for class ch.maxant.rules.JavascriptEngine.Builder

C

ch.maxant.rules - package ch.maxant.rules

compareTo(Rule) - Method in class ch.maxant.rules.Rule

compile() - Method in class ch.maxant.rules.Engine

compile() - Method in class ch.maxant.rules.JavascriptEngine

CompileException - Exception in ch.maxant.rules

Thrown if a Rules expression cannot be compiled when the rule is added to the engine.

CompileException(String) - Constructor for exception ch.maxant.rules.CompileException

D

DEFAULT_INPUT_NAME - Static variable in class ch.maxant.rules.Engine

the name which scripts should use for the input, unless overriden in the constructor/builder.

DuplicateNameException - Exception in ch.maxant.rules

thrown when rules are added to the engine, if another rule has the same fully qualified name.

DuplicateNameException(String) - Constructor for exception ch.maxant.rules.DuplicateNameException

E

Engine - Class in ch.maxant.rules

A Rule Engine.

Engine(Collection<Rule>, boolean) - Constructor for class ch.maxant.rules.Engine

Engine(Collection<Rule>, String, boolean) - Constructor for class ch.maxant.rules.Engine

See Engine.Engine(Collection, boolean)

Engine(Collection<Rule>, String, boolean, Integer, String[]) - Constructor for class ch.maxant.rules.Engine

equals(Object) - Method in class ch.maxant.rules.AbstractAction

equals(Object) - Method in class ch.maxant.rules.Rule

ExecutableAction<Input,Output> - Interface in ch.maxant.rules

A functional interface, so that we can write actions using java 8 lambdas.

execute(Input) - Method in interface ch.maxant.rules.ExecutableAction

Called by the Engine when the associated rule is the winning rule.

executeAllActions(Input, Collection<? extends IAction<Input, Output>>) - Method in class ch.maxant.rules.Engine

See Engine.executeAllActions(String, Object, Collection), except that all namespaces will be considered.

executeAllActions(String, Input, Collection<? extends IAction<Input, Output>>) - Method in class ch.maxant.rules.Engine

Evaluates all rules against the input and then executes all action associated with the positive rules outcomes, in order of highest priority first.

Any outcome is only ever executed once!

NOTE THAT THIS METHOD DISREGARDS ANY RETURN VALUES OF ACTIONS!!

executeBestAction(Input, Collection<? extends IAction<Input, Output>>) - Method in class ch.maxant.rules.Engine

See Engine.executeBestAction(String, Object, Collection), except that all namespaces will be considered.

executeBestAction(String, Input, Collection<? extends IAction<Input, Output>>) - Method in class ch.maxant.rules.Engine

Evaluates all rules against the input and returns the result of the action associated with the rule having the highest priority.

G

getBestOutcome(Input) - Method in class ch.maxant.rules.Engine

See Engine.getBestOutcome(String, Object), except that all namespaces will be considered.

getBestOutcome(String, Input) - Method in class ch.maxant.rules.Engine

Evaluates all rules against the input and returns the result of the outcome associated with the rule having the highest priority.

getDescription() - Method in class ch.maxant.rules.Rule

getExpression() - Method in class ch.maxant.rules.Rule

getFullyQualifiedName() - Method in class ch.maxant.rules.Rule

getMatchingRules(Input) - Method in class ch.maxant.rules.Engine

See Engine.getMatchingRules(String, Object), except that all namespaces will be considered.

getMatchingRules(String, Input) - Method in class ch.maxant.rules.Engine

getMatchingRules(String, Input) - Method in class ch.maxant.rules.JavascriptEngine

getName() - Method in class ch.maxant.rules.AbstractAction

getName() - Method in interface ch.maxant.rules.IAction

getName() - Method in class ch.maxant.rules.Rule

getNamespace() - Method in class ch.maxant.rules.Rule

getOutcome() - Method in class ch.maxant.rules.Rule

getPoolConfig() - Method in class ch.maxant.rules.JavascriptEngine

Subclasses may override this.

getPoolSize() - Method in class ch.maxant.rules.JavascriptEngine

getPriority() - Method in class ch.maxant.rules.Rule

H

hashCode() - Method in class ch.maxant.rules.AbstractAction

hashCode() - Method in class ch.maxant.rules.Rule

I

IAction<Input,Output> - Interface in ch.maxant.rules

This interface is used to create classes capable of being executed when the winning rules outcome is equal to the actions name.

init(Collection<Rule>) - Method in class ch.maxant.rules.Engine

handles the initialisation

inputName - Variable in class ch.maxant.rules.Engine

J

JavascriptEngine - Class in ch.maxant.rules

A Javascript based Subclass of Engine.

JavascriptEngine(Collection<Rule>, boolean, String...) - Constructor for class ch.maxant.rules.JavascriptEngine

Creates the engine with a pool size of .

JavascriptEngine(Collection<Rule>, String, boolean, Integer, boolean, String...) - Constructor for class ch.maxant.rules.JavascriptEngine

See {@link #JavascriptEngine(Collection, boolean, String...)

JavascriptEngine.Builder - Class in ch.maxant.rules

javascriptFilesToLoad - Variable in class ch.maxant.rules.Engine

N

NoActionFoundException - Exception in ch.maxant.rules

Every rule has an outcome.

NoActionFoundException(String) - Constructor for exception ch.maxant.rules.NoActionFoundException

NoMatchingRuleFoundException - Exception in ch.maxant.rules

thrown when no matching rule is found.

NoMatchingRuleFoundException() - Constructor for exception ch.maxant.rules.NoMatchingRuleFoundException

P

parsedRules - Variable in class ch.maxant.rules.Engine

ParseException - Exception in ch.maxant.rules

When replacing SubRule placeholders (the '#' character) in rules, this exception may be thrown if no suitable subrule can be found.

ParseException(String) - Constructor for exception ch.maxant.rules.ParseException

poolSize - Variable in class ch.maxant.rules.Engine

R

Rule - Class in ch.maxant.rules

An Engine contains a list of rules.

Rule(String, String, String, int, String, String) - Constructor for class ch.maxant.rules.Rule

Rule(String, String, String, int, String) - Constructor for class ch.maxant.rules.Rule

See Rule.Rule(String, String, String, int, String, String), just without a description.

S

SubRule - Class in ch.maxant.rules

A sub rule can be used to make rules which are built up from partial expressions and expressions contained in (sub)rules.

SubRule(String, String, String, String) - Constructor for class ch.maxant.rules.SubRule

SubRule(String, String, String) - Constructor for class ch.maxant.rules.SubRule

See SubRule.SubRule(String, String, String, String), just without a description.

T

throwExceptionIfCompilationFails - Variable in class ch.maxant.rules.Engine

toString() - Method in class ch.maxant.rules.AbstractAction

toString() - Method in class ch.maxant.rules.Rule

U

uniqueOutcomes - Variable in class ch.maxant.rules.Engine

W

withInputName(String) - Method in class ch.maxant.rules.JavascriptEngine.Builder

withJavascriptFilesToLoad(String...) - Method in class ch.maxant.rules.JavascriptEngine.Builder

withPoolSize(Integer) - Method in class ch.maxant.rules.JavascriptEngine.Builder

withPreloadPool(boolean) - Method in class ch.maxant.rules.JavascriptEngine.Builder

withThrowExceptionIfCompilationFails(boolean) - Method in class ch.maxant.rules.JavascriptEngine.Builder

A B C D E G H I J N P R S T U W