org.eclipse.actf.validation.rulebase
Class DocumentRuleBaseDescriptor

java.lang.Object
  extended by org.eclipse.actf.validation.rulebase.DocumentRuleBaseDescriptor
All Implemented Interfaces:
Serializable, IRuleBaseDescriptor

public class DocumentRuleBaseDescriptor
extends Object
implements IRuleBaseDescriptor, Serializable

implementation for a document rulebase. Note that this is the only type of rulebase currently supported.

Author:
John Buslawski
See Also:
Serialized Form

Field Summary
static String DOCUMENT
          indicates the document type of rulebase; value is 'document'
 
Constructor Summary
DocumentRuleBaseDescriptor()
           
 
Method Summary
protected  void checkIsValid(String param)
           
 String getRuleBaseFactory()
          get the class name of the factory for instantiating the rulebase being described by this descriptor
 String getRuleBaseName()
          gets the name of the rulebase being described by this descriptor
 String getSourceLocation()
          get the location of the document that describes the rulebase
 String[] getTargets()
           
 String getType()
          gets the type of the rulebase being described
 void setRuleBaseFactory(String rbFactory)
          set the class name of the factory for instantiating rulebases described by this descriptor
 void setRuleBaseName(String ruleBaseName)
          sets the name of the rulebase being described.
 void setSourceLocation(String sourceLocation)
          set the source location of the document that describes the rulebase
 void setTargets(Set targets)
           
 void setType(String sourceType)
          sets the type of the rulebase being described
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOCUMENT

public static final String DOCUMENT
indicates the document type of rulebase; value is 'document'

See Also:
Constant Field Values
Constructor Detail

DocumentRuleBaseDescriptor

public DocumentRuleBaseDescriptor()
Method Detail

getRuleBaseName

public String getRuleBaseName()
gets the name of the rulebase being described by this descriptor

Specified by:
getRuleBaseName in interface IRuleBaseDescriptor
Returns:
name of rulebase

setRuleBaseName

public void setRuleBaseName(String ruleBaseName)
sets the name of the rulebase being described. The name must not be null.

Specified by:
setRuleBaseName in interface IRuleBaseDescriptor
Parameters:
ruleBaseName - name of rulebase being described

getSourceLocation

public String getSourceLocation()
get the location of the document that describes the rulebase

Returns:
the sourceLocation

setSourceLocation

public void setSourceLocation(String sourceLocation)
set the source location of the document that describes the rulebase

Parameters:
sourceLocation - the sourceLocation to set

getType

public String getType()
gets the type of the rulebase being described

Specified by:
getType in interface IRuleBaseDescriptor
Returns:
type of rulebase being described by this descriptor

setType

public void setType(String sourceType)
sets the type of the rulebase being described

Specified by:
setType in interface IRuleBaseDescriptor

getRuleBaseFactory

public String getRuleBaseFactory()
get the class name of the factory for instantiating the rulebase being described by this descriptor

Specified by:
getRuleBaseFactory in interface IRuleBaseDescriptor
Returns:
factory for instantiating the rulebase

setRuleBaseFactory

public void setRuleBaseFactory(String rbFactory)
set the class name of the factory for instantiating rulebases described by this descriptor

Specified by:
setRuleBaseFactory in interface IRuleBaseDescriptor

getTargets

public String[] getTargets()
Returns:
the targets for this rule base mapping

setTargets

public void setTargets(Set targets)

checkIsValid

protected void checkIsValid(String param)
                     throws IllegalArgumentException
Throws:
IllegalArgumentException