Package org.openscience.cdk

Class ReactionScheme

java.lang.Object

org.openscience.cdk.ChemObject

org.openscience.cdk.ReactionSet

org.openscience.cdk.ReactionScheme

All Implemented Interfaces:

Serializable, Cloneable, ICDKObject, IChemObject, IChemObjectListener, IReactionScheme, IReactionSet

Direct Known Subclasses:

DebugReactionScheme

public class ReactionScheme
extends ReactionSet
implements IReactionScheme

Classes that extends the definition of reaction to a scheme. This is designed to contain a set of reactions which are linked in some way but without hard coded semantics.

Author:

miguelrojasch <miguelrojasch@yahoo.es>

See Also:

Serialized Form

Source code:

main

Belongs to CDK module:

data

Keywords:

reaction

Constructor Summary

Constructors

Constructor	Description
ReactionScheme()	Constructs an empty ReactionScheme.

Method Summary

Modifier and Type	Method	Description
void	add(IReactionScheme scheme)	Add a Scheme of Reactions.
Object	clone()	Clones this ReactionScheme object and its content.
int	getReactionSchemeCount()	Returns the number of ReactionScheme in this Scheme.
Iterable<IReactionScheme>	reactionSchemes()	Returns an Iterable for looping over all IMolecularScheme in this ReactionScheme.
void	removeAllReactionSchemes()	Removes all IReactionScheme from this chemObject.
void	removeReactionScheme(IReactionScheme scheme)	Removes an IReactionScheme from this chemObject.

Methods inherited from class org.openscience.cdk.ReactionSet

addReaction, getReaction, getReactionCount, isEmpty, reactions, removeAllReactions, removeReaction, removeReaction, stateChanged, toString

Methods inherited from class org.openscience.cdk.ChemObject

addListener, addProperties, compare, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openscience.cdk.interfaces.ICDKObject

getBuilder

Methods inherited from interface org.openscience.cdk.interfaces.IChemObject

addListener, addProperties, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, toString

Methods inherited from interface org.openscience.cdk.interfaces.IReactionSet

addReaction, getReaction, getReactionCount, isEmpty, reactions, removeAllReactions, removeReaction, removeReaction

Constructor Detail

ReactionScheme

public ReactionScheme()

Constructs an empty ReactionScheme.

Method Detail

add

public void add(IReactionScheme scheme)

Add a Scheme of Reactions.

Specified by:

add in interface IReactionScheme

Parameters:

scheme - The IReactionScheme to include

reactionSchemes

public Iterable<IReactionScheme> reactionSchemes()

Returns an Iterable for looping over all IMolecularScheme in this ReactionScheme.

Specified by:

reactionSchemes in interface IReactionScheme

Returns:

An Iterable with the IMolecularScheme in this ReactionScheme

getReactionSchemeCount

public int getReactionSchemeCount()

Returns the number of ReactionScheme in this Scheme.

Specified by:

getReactionSchemeCount in interface IReactionScheme

Returns:

The number of ReactionScheme in this Scheme

removeAllReactionSchemes

public void removeAllReactionSchemes()

Removes all IReactionScheme from this chemObject.

Specified by:

removeAllReactionSchemes in interface IReactionScheme

removeReactionScheme

public void removeReactionScheme(IReactionScheme scheme)

Removes an IReactionScheme from this chemObject.

Specified by:

removeReactionScheme in interface IReactionScheme

Parameters:

scheme - The IReactionScheme to be removed from this chemObject

clone

public Object clone()
             throws CloneNotSupportedException

Clones this ReactionScheme object and its content.

Specified by:

clone in interface IChemObject

Specified by:

clone in interface IReactionScheme

Overrides:

clone in class ReactionSet

Returns:

The cloned object

Throws:

CloneNotSupportedException - if the IChemObject cannot be cloned