org.kahina.core.data.agent.patterns

Class TreeAutomatonRule

java.lang.Object

org.kahina.core.data.agent.patterns.TreeAutomatonRule

public class TreeAutomatonRule
extends java.lang.Object

Encodes a rule within a TreeAutomaton.

A rule states that the automaton is to annotate with some assignedLabel every node where

1. the children's annotations include a given set of integers, the requiredChildAnnotations
2. the node matches a given tree node pattern, the pattern

Author:

jd

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	verbose

Constructor Summary

Constructors

Constructor and Description
TreeAutomatonRule() Class contructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAssignedLabel() Gets the annotation that is added to nodes to which the rule applies.
KahinaSimpleProperty	getPattern() Gets the tree node pattern required for the rule to apply.
java.util.Set<java.lang.Integer>	getRequiredChildAnnotations() Gets the set of child annotations required for the rule to apply.
boolean	ruleApplies(TreeAutomaton aut, int nodeID) Check whether this rule applies to a tree node in an automaton at the current state.
void	setAssignedLabel(int assignedLabel) Sets the annotation to be added to nodes to which the rule applies.
void	setPattern(KahinaSimpleProperty pattern) Changes the tree node pattern required for the rule to apply.
void	setRequiredChildAnnotations(java.util.Set<java.lang.Integer> requiredChildAnnotations) Changes the set of child annotations required for the rule to apply.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

verbose

public static boolean verbose

Constructor Detail

TreeAutomatonRule

public TreeAutomatonRule()

Class contructor. The default rule matches anything and annotates nothing.

Method Detail

ruleApplies

public boolean ruleApplies(TreeAutomaton aut,
                  int nodeID)

Check whether this rule applies to a tree node in an automaton at the current state.

Parameters:

aut - the automaton that is to be checked (monitoring some tree structure)

nodeID - the tree node to be checked

Returns:

true if this rule applies, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setRequiredChildAnnotations

public void setRequiredChildAnnotations(java.util.Set<java.lang.Integer> requiredChildAnnotations)

Changes the set of child annotations required for the rule to apply.

Parameters:

requiredChildAnnotations - a set of integers representing required child annotations

getRequiredChildAnnotations

public java.util.Set<java.lang.Integer> getRequiredChildAnnotations()

Gets the set of child annotations required for the rule to apply.

Returns:

a set of integers representing the required child annotations

setPattern

public void setPattern(KahinaSimpleProperty pattern)

Changes the tree node pattern required for the rule to apply.

Parameters:

pattern - a tree node pattern defining when the rule is to apply

getPattern

public KahinaSimpleProperty getPattern()

Gets the tree node pattern required for the rule to apply.

Returns:

pattern a tree node pattern defining when the rule applies

setAssignedLabel

public void setAssignedLabel(int assignedLabel)

Sets the annotation to be added to nodes to which the rule applies.

Parameters:

assignedLabel - a stateID a matching node is to be annotated with

getAssignedLabel

public int getAssignedLabel()

Gets the annotation that is added to nodes to which the rule applies.

Returns:

the stateID that matching nodes are annotated with