toxTree.tree.rules

Class UserInputRule

java.lang.Object

java.util.Observable

toxTree.tree.AbstractRule

toxTree.tree.rules.UserInputRule

All Implemented Interfaces:

Serializable, Cloneable, IDecisionInteractive, IDecisionRule, XMLSerializable

Direct Known Subclasses:

UserInputABUnsaturatedAldehyde, UserInputABUnsaturatedAldehyde, UserInputAromaticAmine, UserInputAromaticAmine

public abstract class UserInputRule
extends AbstractRule
implements IDecisionInteractive

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface toxTree.core.IDecisionInteractive

IDecisionInteractive.UserOptions

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyChangeListener	listener
protected String	message
protected IDecisionInteractive.UserOptions	options

Fields inherited from class toxTree.tree.AbstractRule

changes, editable, ERR_STRUCTURENOTPREPROCESSED, examples, explanation, id, logger, MSG_NO, MSG_YES, no, residueIDHidden, title

Fields inherited from interface toxTree.core.XMLSerializable

xmltag_CATEGORIES, xmltag_CATEGORY, xmltag_CATEGORYTHRESHOLD, xmltag_CLASS, xmltag_EXPLANATION, xmltag_ID, xmltag_METHOD, xmltag_METHODPARAMETER, xmltag_METHODS, xmltag_NAME, xmltag_RULE, xmltag_RULEEXAMPLE, xmltag_RULES, xmltag_TREEROOT

Constructor Summary

Constructors

Constructor and Description
UserInputRule()
UserInputRule(String message)

Method Summary

Modifier and Type	Method and Description
boolean	getInteractive()
PropertyChangeListener	getListener()
String	getMessage()
IDecisionInteractive.UserOptions	getOptions()
boolean	isImplemented()
boolean	isSilentvalue()
void	setInteractive(boolean interactive)
void	setListener(PropertyChangeListener listener)
void	setMessage(String message)
void	setOptions(IDecisionInteractive.UserOptions options)
void	setSilentvalue(boolean silentvalue)
boolean	verifyRule(org.openscience.cdk.interfaces.IAtomContainer mol) This is the core of a IDecisionRule behaviour.

Methods inherited from class toxTree.tree.AbstractRule

addPropertyChangeListener, clearFlags, clone, createRule, equals, fromXML, getEditor, getExampleMolecule, getExamples, getExplanation, getID, getNum, getSelector, getTitle, hideResiduesID, isEditable, isResidueIDHidden, log, log, log, makeMolecule, removePropertyChangeListener, setEditable, setExampleMolecule, setExamples, setExplanation, setID, setNum, setTitle, toShallowXML, toString, toXML

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface toxTree.core.IDecisionInteractive

removeListener

Field Detail

message

protected String message

options

protected IDecisionInteractive.UserOptions options

listener

protected PropertyChangeListener listener

Constructor Detail

UserInputRule

public UserInputRule()

UserInputRule

public UserInputRule(String message)

Method Detail

getOptions

public IDecisionInteractive.UserOptions getOptions()

Specified by:

getOptions in interface IDecisionInteractive

setOptions

public void setOptions(IDecisionInteractive.UserOptions options)

Specified by:

setOptions in interface IDecisionInteractive

getListener

public PropertyChangeListener getListener()

Specified by:

getListener in interface IDecisionInteractive

setListener

public void setListener(PropertyChangeListener listener)

Specified by:

setListener in interface IDecisionInteractive

verifyRule

public boolean verifyRule(org.openscience.cdk.interfaces.IAtomContainer mol)
                   throws DecisionMethodException

Description copied from interface: IDecisionRule

This is the core of a 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??

Specified by:

verifyRule in interface IDecisionRule

Parameters:

mol - org.openscience.cdk.interfaces.AtomContainer

Returns:

rule result, boolean

Throws:

DecisionMethodException

isImplemented

public boolean isImplemented()

Specified by:

isImplemented in interface IDecisionRule

Overrides:

isImplemented in class AbstractRule

Returns:

false if the rule is not implemented and true if it is

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

isSilentvalue

public boolean isSilentvalue()

setSilentvalue

public void setSilentvalue(boolean silentvalue)

getInteractive

public boolean getInteractive()

Specified by:

getInteractive in interface IDecisionInteractive

setInteractive

public void setInteractive(boolean interactive)

Specified by:

setInteractive in interface IDecisionInteractive