org.eclipse.actf.validation.valdoc.rulebase
Interface IValidationDocument

All Known Implementing Classes:
ReflectionValidationDocument

public interface IValidationDocument

represents a validation document for document rulebases

Author:
Mike Squillace

Field Summary
static String ACTF_NAMESPACE_URI
          namespace URI for all ACTF documents; value is 'http://www.eclipse.org/projects/actf'
static String DOCUMENT_NAME
          attribute for document name; value = 'name'
static String DOCUMENT_VERSION
          attribute for document version; value = 'version'
static String ENABLE
          attribute for document enablement; value = 'enable'
static String MODEL
          attribute for model; value = 'model'
static String SCRIPTLANG
          attribute for document script language (if any); value = 'scriptlang'
 
Method Summary
 AliasElement[] getAliasElements()
          return an array of alias elements of the document.
 String getDocumentName()
          return the value of the actf:name attribute for this document
 String getDocumentVersion()
          return the value of the actf:version attribute for this document
 String getEnable()
          return the value of the actf:enable attribute
 ExecutionPointDescriptor[] getExecutionPointDescriptors()
          retreave the set of execution point descriptors stipulated in this document.
 String getModelType()
          return the value of the actf:model attribute
 Element[] getRuleSetElements()
          return the list of ruleset elements of the document.
 ScriptElement[] getScriptElements()
          return an array of script elements of the document.
 String getScriptLanguage()
          return the value of the actf:scriptlang attribute
 

Field Detail

ENABLE

static final String ENABLE
attribute for document enablement; value = 'enable'

See Also:
Constant Field Values

MODEL

static final String MODEL
attribute for model; value = 'model'

See Also:
Constant Field Values

DOCUMENT_NAME

static final String DOCUMENT_NAME
attribute for document name; value = 'name'

See Also:
Constant Field Values

SCRIPTLANG

static final String SCRIPTLANG
attribute for document script language (if any); value = 'scriptlang'

See Also:
Constant Field Values

DOCUMENT_VERSION

static final String DOCUMENT_VERSION
attribute for document version; value = 'version'

See Also:
Constant Field Values

ACTF_NAMESPACE_URI

static final String ACTF_NAMESPACE_URI
namespace URI for all ACTF documents; value is 'http://www.eclipse.org/projects/actf'

See Also:
Constant Field Values
Method Detail

getDocumentName

String getDocumentName()
return the value of the actf:name attribute for this document

Returns:
name of document or null if no name is specified

getModelType

String getModelType()
return the value of the actf:model attribute

Returns:
value of actf:enable attribute or null if not present

getEnable

String getEnable()
return the value of the actf:enable attribute

Returns:
value of actf:enable attribute or null if not present

getScriptLanguage

String getScriptLanguage()
return the value of the actf:scriptlang attribute

Returns:
value of actf:scriptlang attribute or null if not present

getScriptElements

ScriptElement[] getScriptElements()
                                  throws MalformedRuleBaseException
return an array of script elements of the document. These elements include immediate children of the <raven:scripts> element. If the <raven:scripts> has only text content, then a single script element should be returned.

Returns:
array of script elements or an empty array if no script elements are present
Throws:
MalformedRuleBaseException

getAliasElements

AliasElement[] getAliasElements()
                                throws MalformedRuleBaseException
return an array of alias elements of the document. These elements include immediate children of the <raven:aliases> element and must have a tag name of 'raven:alias'.

Returns:
array of alias elements or an empty array if no alias elements are present
Throws:
MalformedRuleBaseException

getRuleSetElements

Element[] getRuleSetElements()
return the list of ruleset elements of the document. These elements include immediate children of the <raven:rulesets> element and must have a tag name of 'raven:ruleset'.

Returns:
array of ruleset elements or an empty array if no ruleset elements are present

getExecutionPointDescriptors

ExecutionPointDescriptor[] getExecutionPointDescriptors()
retreave the set of execution point descriptors stipulated in this document. Execution points are used to determine when processes are to be started during the executing application or rendering of or interaction with a document.

Returns:
execution point descriptors specified by this document

getDocumentVersion

String getDocumentVersion()
return the value of the actf:version attribute for this document

Returns:
version of the document or null if no version is specified