Class ChemModel
java.lang.Object
org.openscience.cdk.silent.ChemObject
org.openscience.cdk.silent.ChemModel
- All Implemented Interfaces:
Serializable, Cloneable, ICDKObject, IChemModel, IChemObject, IChemObjectListener
public class ChemModel
extends ChemObject
implements Serializable, IChemModel, IChemObjectListener, Cloneable
An object containing multiple MoleculeSet and
the other lower level concepts like rings, sequences,
fragments, etc.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ICrystalA Crystal.protected IRingSetA RingSet.protected IAtomContainerSetA MoleculeSet.protected IReactionSetA ReactionSet.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 TypeMethodDescriptionclone()Clones thisChemModeland its content.Gets the Crystal contained in this ChemModel.Returns the MoleculeSet of this ChemModel.Gets the ReactionSet contained in this ChemModel.Returns the RingSet of this ChemModel.booleanisEmpty()Returns true if this ChemModel is empty.voidsetCrystal(ICrystal crystal) Sets the Crystal contained in this ChemModel.voidsetMoleculeSet(IAtomContainerSet setOfMolecules) Sets the MoleculeSet of this ChemModel.voidSets the ReactionSet contained in this ChemModel.voidsetRingSet(IRingSet ringSet) Sets the RingSet of this ChemModel.voidCalled by objects to which this object has registered as a listener.toString()Returns a String representation of the contents 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.
-
Field Details
-
setOfMolecules
A MoleculeSet. -
setOfReactions
A ReactionSet. -
ringSet
A RingSet. -
crystal
A Crystal.
-
-
Constructor Details
-
ChemModel
public ChemModel()Constructs an new ChemModel with a null setOfMolecules.
-
-
Method Details
-
getMoleculeSet
Returns the MoleculeSet of this ChemModel.- Specified by:
getMoleculeSetin interfaceIChemModel- Returns:
- The MoleculeSet of this ChemModel
- See Also:
-
setMoleculeSet
Sets the MoleculeSet of this ChemModel.- Specified by:
setMoleculeSetin interfaceIChemModel- Parameters:
setOfMolecules- the content of this model- See Also:
-
getRingSet
Returns the RingSet of this ChemModel.- Specified by:
getRingSetin interfaceIChemModel- Returns:
- the ringset of this model
- See Also:
-
setRingSet
Sets the RingSet of this ChemModel.- Specified by:
setRingSetin interfaceIChemModel- Parameters:
ringSet- the content of this model- See Also:
-
getCrystal
Gets the Crystal contained in this ChemModel.- Specified by:
getCrystalin interfaceIChemModel- Returns:
- The crystal in this model
- See Also:
-
setCrystal
Sets the Crystal contained in this ChemModel.- Specified by:
setCrystalin interfaceIChemModel- Parameters:
crystal- the Crystal to store in this model- See Also:
-
getReactionSet
Gets the ReactionSet contained in this ChemModel.- Specified by:
getReactionSetin interfaceIChemModel- Returns:
- The ReactionSet in this model
- See Also:
-
setReactionSet
Sets the ReactionSet contained in this ChemModel.- Specified by:
setReactionSetin interfaceIChemModel- Parameters:
sor- the ReactionSet to store in this model- See Also:
-
toString
Returns a String representation of the contents of this IChemObject.- Specified by:
toStringin interfaceIChemObject- Overrides:
toStringin classObject- Returns:
- String representation of content
-
clone
Clones thisChemModeland its content.- Specified by:
clonein interfaceIChemObject- Overrides:
clonein classChemObject- Returns:
- The cloned object
- Throws:
CloneNotSupportedException- if the IChemObject cannot be cloned
-
stateChanged
Called by objects to which this object has registered as a listener.- Specified by:
stateChangedin interfaceIChemObjectListener- Parameters:
event- A change event pointing to the source of the change
-
isEmpty
public boolean isEmpty()Returns true if this ChemModel is empty.- Specified by:
isEmptyin interfaceIChemModel- Returns:
- a boolean indicating if this model has no content
-