org.eclipse.actf.validation.rulebase
Interface IDocumentRuleBase

All Superinterfaces:
IRuleBase
All Known Implementing Classes:
ValidationDocumentRuleBase

public interface IDocumentRuleBase
extends IRuleBase

interface embodying a rulebase expressed as an XML document. See the "Validation ReflectionValidationDocument Authoring Guide" for details on the structure and syntax of a validation document.

Note: The document rulebase is currently the only rulebase supported by ACTF.

Author:
John Buslawski

Field Summary
static String ALIASES_ID
          model pool id for aliases - value is 'aliases'
 
Method Summary
 ICodeProcessor getCodeProcessor()
          Retrieve the ICodeProcessor for this IRuleBase.
 URL getDocumentLocation()
          Retrieve the URL of the document used for building the IRuleBase.
 IModel getModel()
          Retrieve the model for this IRuleBase.
 void setCodeProcessor(ICodeProcessor codeProc)
          Set the ICodeProcessor for this IRuleBase
 void setDocumentLocation(URL location)
          Set the URL of the document used for building the IRuleBase.
 void setModel(IModel model)
          Set the model for this IRuleBase
 
Methods inherited from interface org.eclipse.actf.validation.rulebase.IRuleBase
addExecutionPointDescriptor, addRuleSet, getExecutionPointDescriptor, getExecutionPointDescriptors, getMetadata, getModelType, getName, getRuleSets, getRuleSetsForExecutionPoint, getVersion, isEnabled, removeExecutionPointDescriptor, removeRuleSet, setEnabled, setExecutionPointDescriptors, setMetadata, setModelType, setName, setRuleSets, setVersion
 

Field Detail

ALIASES_ID

static final String ALIASES_ID
model pool id for aliases - value is 'aliases'

See Also:
Constant Field Values
Method Detail

getDocumentLocation

URL getDocumentLocation()
Retrieve the URL of the document used for building the IRuleBase.

Returns:
URL of the validation document

setDocumentLocation

void setDocumentLocation(URL location)
Set the URL of the document used for building the IRuleBase.

Parameters:
location - - URL of the validation document

getCodeProcessor

ICodeProcessor getCodeProcessor()
Retrieve the ICodeProcessor for this IRuleBase. The ICodeProcessor is derived by the <actf:scriptlang> attribute of the root <raven:rulebase> element.

Returns:
ICodeProcessor instance for the IRuleBase

getModel

IModel getModel()
Retrieve the model for this IRuleBase. The model is derived by the <raven:model> attribute of the root <raven:rulebase> element.

Returns:
model instance for the IRuleBase

setCodeProcessor

void setCodeProcessor(ICodeProcessor codeProc)
Set the ICodeProcessor for this IRuleBase

Parameters:
codeProc - - ICodeProcessor instance for the IRuleBase

setModel

void setModel(IModel model)
Set the model for this IRuleBase

Parameters:
model - - IModel instance for the IRuleBase