net.sourceforge.nrl.parser.ast
Interface IRuleFile

All Superinterfaces:

INRLAstNode

public interface IRuleFile
extends INRLAstNode

IRuleFile is the top level interface - it contains the entire, fully resolved AST of a rule file.

Field Summary

Fields inherited from interface net.sourceforge.nrl.parser.ast.INRLAstNode

NEWLINE

Method Summary

List<IDeclaration>	getDeclarations() Return a collection of the declarations in this file.
List<IVariableDeclaration>	getGlobalVariableDeclarations() Get the list of global variable declarations.
IModelFileReference[]	getModelFileReferences() Return the model file references, as they were declared in this rule file.
IOperatorFileReference[]	getOperatorFileReferences() Return an array of operator file references - can be empty.
IRuleDeclaration	getRuleById(String id) Look up a rule declaration by ID.
List<IRuleSetDeclaration>	getRuleSetDeclarations() Return a list of all rule set declarations.

Methods inherited from interface net.sourceforge.nrl.parser.ast.INRLAstNode

accept, dump, getColumn, getLine, getUserData, setUserData

Method Detail

getModelFileReferences

IModelFileReference[] getModelFileReferences()

Return the model file references, as they were declared in this rule file.

Returns:

the file references

getOperatorFileReferences

IOperatorFileReference[] getOperatorFileReferences()

Return an array of operator file references - can be empty.

Returns:

the file references

getDeclarations

List<IDeclaration> getDeclarations()

Return a collection of the declarations in this file. This is a heterogeneous collection. It contains both IConstraintRuleDeclaration and IValidationFragmentDeclaration objects.

Clients calling this method should be defensive and check each objects to ensure it is handled correctly.

Returns:

the collection of declarations

getRuleById

IRuleDeclaration getRuleById(String id)

Look up a rule declaration by ID.

Parameters:

id - the rule id

Returns:

the rule or null if not found

getRuleSetDeclarations

List<IRuleSetDeclaration> getRuleSetDeclarations()

Return a list of all rule set declarations. This is a list of IRuleSetDeclaration objects.

Returns:

the collection of declarations

getGlobalVariableDeclarations

List<IVariableDeclaration> getGlobalVariableDeclarations()

Get the list of global variable declarations. This list is a collection of IVariableDeclaration objects with some special properties:

• IVariableDeclaration.getExpression() is always an ILiteralString, IDecimalNumber or IIntegerNumber, but never a model reference.
• IVariableDeclaration#getConstraint() is always null