org.eclipse.actf.validation.rulebase
Interface IDocumentRuleBaseMetadata

All Superinterfaces:
IRuleBaseMetadata
All Known Implementing Classes:
ValidationDocumentRuleBaseMetadata

public interface IDocumentRuleBaseMetadata
extends IRuleBaseMetadata

implemented to provide metadata for a document rulebase. This will contain (at the very least) the script processor used by the rulebase.

Author:
John Buslawski

Field Summary
static String ALIASES
           
static String SCRIPTS
           
 
Method Summary
 Properties getAliases()
          get the aliases associated with a document
 String getAliasValue(String aliasName)
          Get the alias value for the given alias name.
 URL getDocumentLocation()
           
 ScriptElement[] getScripts()
          retreave the scripts associated with a document
 void setAliases(Properties aliases)
          retreave the aliases for a document.
 void setDocumentLocation(URL location)
           
 void setScripts(ScriptElement[] scripts)
          set the list of scripts to be associated with a document.
 
Methods inherited from interface org.eclipse.actf.validation.rulebase.IRuleBaseMetadata
clear, getAttribute, getAttributeNames, getAttributes, setAttribute, setAttributes, size
 

Field Detail

SCRIPTS

static final String SCRIPTS
See Also:
Constant Field Values

ALIASES

static final String ALIASES
See Also:
Constant Field Values
Method Detail

getDocumentLocation

URL getDocumentLocation()
Returns:
URL of document or null if no name is specified

setDocumentLocation

void setDocumentLocation(URL location)
Parameters:
location - URL of document

getScripts

ScriptElement[] getScripts()
retreave the scripts associated with a document

Returns:
list of script elements or an empty list if no script elements are present

setScripts

void setScripts(ScriptElement[] scripts)
set the list of scripts to be associated with a document. Scripts are defined in the document with the <raven:scripts> element.

Scripts will typically be executed by a ICodeProcessor object.

Parameters:
scripts - is a list of script elements or an empty list if no script elements are present
See Also:
ICodeProcessor

getAliases

Properties getAliases()
get the aliases associated with a document

Returns:
map of alias name/value pairs or an empty map if no alias elements are present
See Also:
setAliases(Properties)

getAliasValue

String getAliasValue(String aliasName)
Get the alias value for the given alias name.

Parameters:
aliasName - -- alias name
Returns:
value of alias or null if no alias is defined for the given name

setAliases

void setAliases(Properties aliases)
retreave the aliases for a document. Aliases are name-value pairs for convenient reference to fully-qualified names. Aliases are defined using the <raven:alias> element in a validation document.

Parameters:
aliases - is a map of alias name/value pairs