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
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:
- Keywords:
- reaction
-
Field Summary
Fields inherited from interface IChemObject
ALIPHATIC, AROMATIC, CONJUGATED, HIDDEN, HYDROGEN_BOND_ACCEPTOR, HYDROGEN_BOND_DONOR, IN_RING, MAPPED, MARKUSH, NOT_IN_RING, PLACED, REACTIVE_CENTER, SINGLE_OR_DOUBLE, TYPEABLE, VISITEDModifier and TypeFieldDescriptionstatic final intFlag that is set if a ChemObject is part of an aliphatic chain.static final intFlag is set if ChemObject is part of an aromatic system.static final intFlag is set if ChemObject is part of a conjugated system.static final intThis flag can be used when depicted structures to hide certain parts, for example the things are abbreviated (display shortcuts).static final intSets to true if the atom is a hydrogen bond acceptor.static final intSets to true if the atom is a hydrogen bond donor.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag is set if a ChemObject is mapped to another ChemObject.static final intFlag to indicate a flattened molecule holds a Markush structure, you can work on it as is or it might make more sense to repack into something sensible like a RGroupQuery.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag that is set if the ChemObject is placed when calculating 2D/3D layouts.static final intFlag is set if a ChemObject has reactive center.static final intFlag used for marking uncertainty of the bond order.static final intFlag is set if an atom could be typed.static final intFlag is set if ChemObject has been visited. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(IReactionScheme scheme) Add a Scheme of Reactions.clone()Clones this ReactionScheme object and its content.intReturns the number of ReactionScheme in this Scheme.Returns an Iterable for looping over all IMolecularScheme in this ReactionScheme.voidRemoves all IReactionScheme from this chemObject.voidremoveReactionScheme(IReactionScheme scheme) Removes an IReactionScheme from this chemObject.Methods inherited from class ReactionSet
addReaction, getReaction, getReactionCount, isEmpty, reactions, removeAllReactions, removeReaction, removeReaction, stateChanged, toStringModifier and TypeMethodDescriptionvoidaddReaction(IReaction reaction) Adds an reaction to this container.getReaction(int number) Returns the Reaction at positionnumberin the container.intReturns the number of Reactions in this Container.booleanisEmpty()Returns true if this IReactionSet is empty.Get an iterator for this reaction set.voidRemoves all Reactions from this container.voidremoveReaction(int pos) Remove a reaction from this set.voidremoveReaction(IReaction relevantReaction) Removes all instances of a reaction from this IReactionSet.voidCalled by objects to notify objects that implemented this interface and registered with them as ChemObjectListeners.toString()Returns a one line description of this IChemObject.Methods inherited from class ChemObject
addListener, addProperties, clear, compare, flags, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, is, notifyChanged, notifyChanged, removeListener, removeProperty, set, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopyModifier and TypeMethodDescriptionvoidUse this to add yourself to this IChemObject as a listener.voidaddProperties(Map<Object, Object> properties) Sets the properties of this object.voidclear(int flags) Clear the provided flags.booleanCompares a IChemObject with this IChemObject.intflags()Access the current value of the flags for this ChemObject.Returns aIChemObjectBuilderfor the data classes that extend this class.booleangetFlag(int mask) Returns the value of a given flag.boolean[]getFlags()Returns the whole set of flags.Access the internal value used to store the flags.getID()Returns the identifier (ID) of this object.intReturns the number of ChemObjectListeners registered with this object.booleanReturns the flag that indicates whether notification messages are sent around.Returns a Map with the IChemObject's properties.<T> TgetProperty(Object description) Returns a property for the IChemObject.<T> TgetProperty(Object description, Class<T> c) Access a property of the given description and cast the specified class.booleanis(int flags) Test if a flag(s) are set on this ChemObject.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidUse this to remove a ChemObjectListener from the ListenerList of this IChemObject.voidremoveProperty(Object description) Removes a property for a IChemObject.voidset(int flags) Set the provided flags.voidsetFlag(int mask, boolean value) Sets the value of some flag.voidsetFlags(boolean[] flagsNew) Sets the whole set of flags.voidSets the identifier (ID) of this object.voidsetNotification(boolean bool) Set a flag to use or not use notification.voidsetProperties(Map<Object, Object> properties) Set the properties of this object to the provided map (shallow copy).voidsetProperty(Object description, Object property) Sets a property for a IChemObject.Clones thisIChemObject, but preserves references toObjects.
-
Constructor Details
-
ReactionScheme
public ReactionScheme()Constructs an empty ReactionScheme.
-
-
Method Details
-
add
Add a Scheme of Reactions.- Specified by:
addin interfaceIReactionScheme- Parameters:
scheme- The IReactionScheme to include
-
reactionSchemes
Returns an Iterable for looping over all IMolecularScheme in this ReactionScheme.- Specified by:
reactionSchemesin interfaceIReactionScheme- Returns:
- An Iterable with the IMolecularScheme in this ReactionScheme
-
getReactionSchemeCount
public int getReactionSchemeCount()Returns the number of ReactionScheme in this Scheme.- Specified by:
getReactionSchemeCountin interfaceIReactionScheme- Returns:
- The number of ReactionScheme in this Scheme
-
removeAllReactionSchemes
public void removeAllReactionSchemes()Removes all IReactionScheme from this chemObject.- Specified by:
removeAllReactionSchemesin interfaceIReactionScheme
-
removeReactionScheme
Removes an IReactionScheme from this chemObject.- Specified by:
removeReactionSchemein interfaceIReactionScheme- Parameters:
scheme- The IReactionScheme to be removed from this chemObject
-
clone
Clones this ReactionScheme object and its content.- Specified by:
clonein interfaceIChemObject- Specified by:
clonein interfaceIReactionScheme- Overrides:
clonein classReactionSet- Returns:
- The cloned object
- Throws:
CloneNotSupportedException- if the IChemObject cannot be cloned
-