|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDecisionRule
An interface definition to represent a rule, that will be used in a IDecisionMethod
.
All classes, implementing a rule to be used in toxTree application should implement this interface.
Method Summary | |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l)
|
void |
clearFlags(org.openscience.cdk.interfaces.IAtomContainer mol)
When rules analyze a molecule, a set of properties are set. |
java.lang.Object |
clone()
|
IDecisionRuleEditor |
getEditor()
Each rule provides an editor, which is a class implementing IDecisionRuleEditor . |
org.openscience.cdk.interfaces.IMolecule |
getExampleMolecule(boolean ruleResult)
if ruleResult is TRUE, returns the example molecule if the rule is answered YES if ruleResult is FALSE, returns the example molecule if the rule is answered NO |
java.lang.String |
getExplanation()
Rule explanation is an arbitrary text, could be multiline and may contain html tags. |
java.lang.String |
getID()
Rule identifier is an arbitrary string, preferably short one |
int |
getNum()
|
ambit2.base.interfaces.IProcessor<org.openscience.cdk.interfaces.IAtomContainer,org.openscience.cdk.renderer.selection.IChemObjectSelection> |
getSelector()
|
java.lang.String |
getTitle()
Rule name is an arbitrary string, preferably one line, reflecting the essence of the rule (e.g. |
void |
hideResiduesID(boolean hide)
|
boolean |
isEditable()
|
boolean |
isImplemented()
|
boolean |
isResidueIDHidden()
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l)
|
void |
setEditable(boolean value)
|
void |
setExampleMolecule(org.openscience.cdk.interfaces.IAtomContainer mol,
boolean ruleResult)
Sets example molecule for the YES or NO answer of the rule |
void |
setExplanation(java.lang.String message)
Sets rule explanation |
void |
setID(java.lang.String id)
Sets rule identifier |
void |
setNum(int no)
|
void |
setTitle(java.lang.String name)
Sets rule name |
java.lang.String |
toString()
|
boolean |
verifyRule(org.openscience.cdk.interfaces.IAtomContainer mol)
This is the core of a IDecisionRule behaviour. |
Method Detail |
---|
java.lang.String getID()
void setID(java.lang.String id)
id
- int getNum()
void setNum(int no)
java.lang.String getTitle()
void setTitle(java.lang.String name)
name
- java.lang.String getExplanation()
void setExplanation(java.lang.String message)
message
- org.openscience.cdk.interfaces.IMolecule getExampleMolecule(boolean ruleResult) throws DecisionMethodException
ruleResult
-
org.openscience.cdk.interfaces.Molecule
{@link
- DecisionMethodException}
DecisionMethodException
void setExampleMolecule(org.openscience.cdk.interfaces.IAtomContainer mol, boolean ruleResult)
mol
- org.openscience.cdk.interfaces.Molecule
ruleResult
- void clearFlags(org.openscience.cdk.interfaces.IAtomContainer mol)
mol
- org.openscience.cdk.interfaces.Molecule
boolean verifyRule(org.openscience.cdk.interfaces.IAtomContainer mol) throws DecisionMethodException
IDecisionRule
behaviour. The method returns true
if the answer of the rule is YES for the analyzed molecule org.openscience.cdk.interfaces.AtomContainer
and FALSE
if the answer of the rule is NO for the analyzed molecule org.openscience.cdk.interfaces.AtomContainer
??
mol
- org.openscience.cdk.interfaces.AtomContainer
{@link
- DecisionMethodException}
DecisionMethodException
java.lang.String toString()
toString
in class java.lang.Object
void addPropertyChangeListener(java.beans.PropertyChangeListener l)
void removePropertyChangeListener(java.beans.PropertyChangeListener l)
boolean isImplemented()
void hideResiduesID(boolean hide)
boolean isResidueIDHidden()
IDecisionRuleEditor getEditor()
IDecisionRuleEditor
.
The editor shall provide user interface for visualization and modification of various rule settings.
IDecisionRuleEditor
java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
boolean isEditable()
void setEditable(boolean value)
ambit2.base.interfaces.IProcessor<org.openscience.cdk.interfaces.IAtomContainer,org.openscience.cdk.renderer.selection.IChemObjectSelection> getSelector()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |