databionics.io
Class Rule

java.lang.Object
  extended by databionics.io.DataItem
      extended by databionics.io.Rule
Direct Known Subclasses:
CharRule, DiffRule

public abstract class Rule
extends DataItem

Abstract base class for rules


Field Summary
protected  java.lang.String caseKey
          The name of the key column of the cases.
protected  java.lang.String caseName
          The (file)name of the cases used to generate the rule
protected  java.lang.String className
          The name of the class described by the rule.
protected  java.util.List conditions
          The rule conditions.
protected static org.apache.log4j.Logger log
          Log4j logging.
protected  java.lang.String name
          The name of rule.
protected  java.lang.String operator
          The operator between the conditions
 
Fields inherited from class databionics.io.DataItem
index
 
Constructor Summary
Rule()
          Standard constructor
Rule(java.lang.String name, java.lang.String caseKey, java.lang.String className, java.lang.String caseName, java.lang.String operator)
          Constructor with all important fields.
 
Method Summary
 java.lang.String getCaseKey()
          Get CaseKey.
 java.lang.String getCaseName()
          Get CaseName.
 java.lang.String getClassName()
          Get ClassName.
 java.util.List getConditions()
          Get Conditions.
 java.lang.String getName()
          Get name of rule.
 java.lang.String getOperator()
          Get Operator.
protected abstract  java.lang.String header(java.lang.String delimiter)
          Generate start of rule.
static Rule parseRule(java.lang.String text)
          Parse a rule from a string.
 void setCaseKey(java.lang.String caseKey)
          Set CaseKey.
 void setCaseName(java.lang.String caseName)
          Set CaseName.
 void setClassName(java.lang.String className)
          Set ClassName.
 void setConditions(java.util.List conditions)
          Set Conditions.
 void setName(java.lang.String name)
          Set name of rule.
 void setOperator(java.lang.String operator)
          Set Operator.
 java.lang.String toString(java.lang.String delimiter)
          String representation.
 
Methods inherited from class databionics.io.DataItem
getIndex, setIndex, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static org.apache.log4j.Logger log
Log4j logging.


name

protected java.lang.String name
The name of rule.


caseKey

protected java.lang.String caseKey
The name of the key column of the cases.


className

protected java.lang.String className
The name of the class described by the rule.


caseName

protected java.lang.String caseName
The (file)name of the cases used to generate the rule


conditions

protected java.util.List conditions
The rule conditions.


operator

protected java.lang.String operator
The operator between the conditions

Constructor Detail

Rule

public Rule()
Standard constructor


Rule

public Rule(java.lang.String name,
            java.lang.String caseKey,
            java.lang.String className,
            java.lang.String caseName,
            java.lang.String operator)
Constructor with all important fields.

Parameters:
name - Name of the rule
caseKey - Name of the key column of the cases.
className - Name of the class described by the rule.
caseName - Name of the cases used to generate the rule
operator - Name of operator between the conditions
Method Detail

parseRule

public static Rule parseRule(java.lang.String text)
Parse a rule from a string. Returns a CharRule or a DiffRule

Parameters:
rule - as string
Returns:
rule as object

setCaseKey

public void setCaseKey(java.lang.String caseKey)
Set CaseKey.


getCaseKey

public java.lang.String getCaseKey()
Get CaseKey.


setClassName

public void setClassName(java.lang.String className)
Set ClassName.


getClassName

public java.lang.String getClassName()
Get ClassName.


setCaseName

public void setCaseName(java.lang.String caseName)
Set CaseName.


getCaseName

public java.lang.String getCaseName()
Get CaseName.


setName

public void setName(java.lang.String name)
Set name of rule.


getName

public java.lang.String getName()
Get name of rule.


setConditions

public void setConditions(java.util.List conditions)
Set Conditions.


getConditions

public java.util.List getConditions()
Get Conditions.


setOperator

public void setOperator(java.lang.String operator)
Set Operator.


getOperator

public java.lang.String getOperator()
Get Operator.


header

protected abstract java.lang.String header(java.lang.String delimiter)
Generate start of rule. To be implemented by subclasses


toString

public java.lang.String toString(java.lang.String delimiter)
String representation.

Specified by:
toString in class DataItem


Copyright © 2005-2006 Databionics Research Group. All Rights Reserved.