com.goldencode.p2j.pattern

Class RuleSet

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.pattern.RuleContainer

com.goldencode.p2j.pattern.RuleSet

All Implemented Interfaces:

DebugLevels, RuleListElement

public final class RuleSet
extends RuleContainer

A rule container implementation which adds a choice of input mode. A ruleset is essentially a list of rules which is applied against one or more ASTs. For each AST, the entire list of rules is applied in turn. Rules can test conditions based upon an AST's properties and perform actions conditionally for diverse purposes.

Input mode determines whether this ruleset is applied against an entire AST via a depth first iteration of its nodes, or against a filtered view of an AST which contains only those nodes which have been added to the view, based upon some previous test.

See Also:

setInputMode(int), Rule

Field Summary

Fields

Modifier and Type	Field and Description
private int	depth Maximum walk depth for ASTs to which this ruleset is applied
private boolean	honorHidden Honor hidden processing mode flag.
static int	INPUT_TREE Indicates this ruleset will iterate over an AST structure
static int	INPUT_VIEW Indicates this ruleset will iterate over a filtered list of ASTs
private int	inputMode Input mode (tree or view) associated with this ruleset

Fields inherited from class com.goldencode.p2j.pattern.RuleContainer

RULE_ASCENT, RULE_DESCENT, RULE_INIT, RULE_NEXT_CHILD, RULE_NONE, RULE_POST, RULE_WALK

Fields inherited from interface com.goldencode.p2j.pattern.DebugLevels

MSG_DEBUG, MSG_NONE, MSG_STATUS, MSG_TRACE

Constructor Summary

Constructors

Constructor and Description
RuleSet(RuleContainer parent) Constructor which assigns enclosing scope.

Method Summary

Modifier and Type	Method and Description
int	getDepth() Get the maximum walk depth, where 0 indicates all levels should be visited.
(package private) int	getInputMode() Gets the input mode currently associated with this ruleset.
boolean	isHonorHidden() Gets the flag that determines if the hidden status of an AST node should be honored.
void	setDepth(int depth) Set the maximum walk depth, where 0 indicates all levels should be visited.
void	setHonorHidden(boolean hide) Sets the flag that determines if the hidden status of an AST node should be honored.
void	setInputMode(int inputMode) Set the input mode for use with this ruleset.

Methods inherited from class com.goldencode.p2j.pattern.RuleContainer

addRule, addRuleSet, apply, cleanup, getDebugLevel, getEnclosingScope, getFunction, getFunctionContainer, getWorker, hasType, include, isContainer, putFunction, registerVariable, registerVariableValue, registerWorker, registerWorker, ruleList, setDebugLevel

Methods inherited from class com.goldencode.expr.Scope

getLibraries, getLibraryClasses, getLibsByClass, getVariableList, getVariables

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_TREE

public static final int INPUT_TREE

Indicates this ruleset will iterate over an AST structure

See Also:

Constant Field Values

INPUT_VIEW

public static final int INPUT_VIEW

Indicates this ruleset will iterate over a filtered list of ASTs

See Also:

Constant Field Values

inputMode

private int inputMode

Input mode (tree or view) associated with this ruleset

depth

private int depth

Maximum walk depth for ASTs to which this ruleset is applied

honorHidden

private boolean honorHidden

Honor hidden processing mode flag.

Constructor Detail

RuleSet

public RuleSet(RuleContainer parent)

Constructor which assigns enclosing scope.

Parameters:

parent - Rule container which provides enclosing scope to this ruleset.

Method Detail

getInputMode

int getInputMode()

Gets the input mode currently associated with this ruleset.

Returns:

INPUT_TREE or INPUT_VIEW.

See Also:

setInputMode(int)

setInputMode

public void setInputMode(int inputMode)

Set the input mode for use with this ruleset. Input mode determines whether this ruleset is applied against an AST directly or through a filtered view created by a ruleset which has run previously in a pipeline of rulesets. A filtered view is created each time a ruleset is applied. An individual rule may add AST nodes to the view using user functions implemented by CommonAstSupport. This view is passed along to the next ruleset in the pipeline and is used as the basis for that ruleset's iteration if its input mode is set to INPUT_VIEW.

Parameters:

inputMode - INPUT_TREE to apply this ruleset against an AST directly; INPUT_VIEW to apply this ruleset against a filtered view of ASTs.

getDepth

public int getDepth()

Get the maximum walk depth, where 0 indicates all levels should be visited.

Returns:

Maximum walk depth.

setDepth

public void setDepth(int depth)

Set the maximum walk depth, where 0 indicates all levels should be visited.

Parameters:

depth - Maximum walk depth.

isHonorHidden

public boolean isHonorHidden()

Gets the flag that determines if the hidden status of an AST node should be honored. Note: this is only effective in top-level rule-sets (the value is meaningless in nested rule-sets).

Returns:

true if a node's hidden flag should be honored.

setHonorHidden

public void setHonorHidden(boolean hide)

Sets the flag that determines if the hidden status of an AST node should be honored. Note: this is only effective in top-level rule-sets (the value is meaningless in nested rule-sets).

Parameters:

hide - true if a node's hidden flag should be honored.