org.openscience.cdk.debug

Class DebugChemModel

java.lang.Object

org.openscience.cdk.ChemObject

org.openscience.cdk.ChemModel

org.openscience.cdk.debug.DebugChemModel

All Implemented Interfaces:

Serializable, Cloneable, ICDKObject, IChemModel, IChemObject, IChemObjectListener

public class DebugChemModel
extends ChemModel
implements IChemModel

Debugging data class.

Author:

egonw

See Also:

Serialized Form

Source code:

master

Belongs to CDK module:

datadebug

Field Summary

Fields inherited from class org.openscience.cdk.ChemModel

crystal, ringSet, setOfMolecules, setOfReactions

Constructor Summary

Constructors

Constructor and Description
DebugChemModel()

Method Summary

Modifier and Type	Method and Description
void	addListener(IChemObjectListener col) Use this to add yourself to this IChemObject as a listener.
void	addProperties(Map<Object,Object> properties) Sets the properties of this object.
Object	clone() Clones this ChemModel and its content.
IChemObjectBuilder	getBuilder() Returns a IChemObjectBuilder for the data classes that extend this class.
ICrystal	getCrystal() Gets the Crystal contained in this ChemModel.
boolean	getFlag(int flagType) Returns the value of a given flag.
boolean[]	getFlags() Returns the whole set of flags.
String	getID() Returns the identifier (ID) of this object.
int	getListenerCount() Returns the number of ChemObjectListeners registered with this object.
IAtomContainerSet	getMoleculeSet() Returns the MoleculeSet of this ChemModel.
Map<Object,Object>	getProperties() Returns a Map with the IChemObject's properties.
<T> T	getProperty(Object description) Returns a property for the IChemObject.
IReactionSet	getReactionSet() Gets the ReactionSet contained in this ChemModel.
IRingSet	getRingSet() Returns the RingSet of this ChemModel.
boolean	isEmpty() Returns true if this ChemModel is empty.
void	notifyChanged() This should be triggered by an method that changes the content of an object to that the registered listeners can react to it.
void	notifyChanged(IChemObjectChangeEvent evt) This should be triggered by an method that changes the content of an object to that the registered listeners can react to it.
void	removeListener(IChemObjectListener col) Use this to remove a ChemObjectListener from the ListenerList of this IChemObject.
void	removeProperty(Object description) Removes a property for a IChemObject.
void	setCrystal(ICrystal crystal) Sets the Crystal contained in this ChemModel.
void	setFlag(int flagType, boolean flagValue) Sets the value of some flag.
void	setFlags(boolean[] flagsNew) Sets the whole set of flags.
void	setID(String identifier) Sets the identifier (ID) of this object.
void	setMoleculeSet(IAtomContainerSet setOfMolecules) Sets the MoleculeSet of this ChemModel.
void	setProperty(Object description, Object property) Sets a property for a IChemObject.
void	setReactionSet(IReactionSet sor) Sets the ReactionSet contained in this ChemModel.
void	setRingSet(IRingSet ringSet) Sets the RingSet of this ChemModel.

Methods inherited from class org.openscience.cdk.ChemModel

stateChanged, toString

Methods inherited from class org.openscience.cdk.ChemObject

compare, getFlagValue, getNotification, getProperty, setNotification, setProperties, 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.IChemObject

getFlagValue, getNotification, getProperty, setNotification, setProperties, toString

Constructor Detail

DebugChemModel

public DebugChemModel()

Method Detail

addListener

public void addListener(IChemObjectListener col)

Use this to add yourself to this IChemObject as a listener. In order to do so, you must implement the ChemObjectListener Interface.

Specified by:

addListener in interface IChemObject

Overrides:

addListener in class ChemObject

Parameters:

col - the ChemObjectListener

See Also:

ChemObject.removeListener(org.openscience.cdk.interfaces.IChemObjectListener)

getListenerCount

public int getListenerCount()

Returns the number of ChemObjectListeners registered with this object.

Specified by:

getListenerCount in interface IChemObject

Overrides:

getListenerCount in class ChemObject

Returns:

the number of registered listeners.

removeListener

public void removeListener(IChemObjectListener col)

Use this to remove a ChemObjectListener from the ListenerList of this IChemObject. It will then not be notified of change in this object anymore.

Specified by:

removeListener in interface IChemObject

Overrides:

removeListener in class ChemObject

Parameters:

col - The ChemObjectListener to be removed

See Also:

ChemObject.addListener(org.openscience.cdk.interfaces.IChemObjectListener)

notifyChanged

public void notifyChanged()

This should be triggered by an method that changes the content of an object to that the registered listeners can react to it.

Specified by:

notifyChanged in interface IChemObject

Overrides:

notifyChanged in class ChemObject

notifyChanged

public void notifyChanged(IChemObjectChangeEvent evt)

This should be triggered by an method that changes the content of an object to that the registered listeners can react to it. This is a version of notifyChanged() which allows to propagate a change event while preserving the original origin.

Specified by:

notifyChanged in interface IChemObject

Overrides:

notifyChanged in class ChemObject

Parameters:

evt - A ChemObjectChangeEvent pointing to the source of where the change happened

setProperty

public void setProperty(Object description,
                        Object property)

Sets a property for a IChemObject.

Specified by:

setProperty in interface IChemObject

Overrides:

setProperty in class ChemObject

Parameters:

description - An object description of the property (most likely a unique string)

property - An object with the property itself

See Also:

ChemObject.getProperty(java.lang.Object), ChemObject.removeProperty(java.lang.Object)

removeProperty

public void removeProperty(Object description)

Removes a property for a IChemObject.

Specified by:

removeProperty in interface IChemObject

Overrides:

removeProperty in class ChemObject

Parameters:

description - The object description of the property (most likely a unique string)

See Also:

ChemObject.setProperty(java.lang.Object, java.lang.Object), ChemObject.getProperty(java.lang.Object)

getProperty

public <T> T getProperty(Object description)

Returns a property for the IChemObject.

Specified by:

getProperty in interface IChemObject

Overrides:

getProperty in class ChemObject

Type Parameters:

T - generic return type

Parameters:

description - An object description of the property (most likely a unique string)

Returns:

The object containing the property. Returns null if propert is not set.

See Also:

ChemObject.setProperty(java.lang.Object, java.lang.Object), ChemObject.removeProperty(java.lang.Object)

getProperties

public Map<Object,Object> getProperties()

Returns a Map with the IChemObject's properties.

Specified by:

getProperties in interface IChemObject

Overrides:

getProperties in class ChemObject

Returns:

The object's properties as an Hashtable

See Also:

ChemObject.addProperties(java.util.Map<java.lang.Object, java.lang.Object>)

getID

public String getID()

Returns the identifier (ID) of this object.

Specified by:

getID in interface IChemObject

Overrides:

getID in class ChemObject

Returns:

a String representing the ID value

See Also:

ChemObject.setID(java.lang.String)

setID

public void setID(String identifier)

Sets the identifier (ID) of this object.

Specified by:

setID in interface IChemObject

Overrides:

setID in class ChemObject

Parameters:

identifier - a String representing the ID value

See Also:

ChemObject.getID()

setFlag

public void setFlag(int flagType,
                    boolean flagValue)

Sets the value of some flag. The flag is a mask from a given CDKConstant (e.g. CDKConstants.ISAROMATIC or CDKConstants.VISITED). The flags are intrinsic internal properties and should not be used to store custom values, please use IChemObject.setProperty(Object, Object).

 // set this chem object to be aromatic
 chemObject.setFlag(CDKConstants.ISAROMATIC, Boolean.TRUE);
 // ...
 // indicate we have visited this chem object
 chemObject.setFlag(CDKConstants.VISITED, Boolean.TRUE);
 

Specified by:

setFlag in interface IChemObject

Overrides:

setFlag in class ChemObject

Parameters:

flagType - flag to set the value for

flagValue - value to assign to flag

See Also:

IChemObject.getFlag(int), CDKConstants

getFlag

public boolean getFlag(int flagType)

Returns the value of a given flag. The flag is a mask from a given CDKConstant (e.g. CDKConstants.ISAROMATIC).

 if(chemObject.getFlag(CDKConstants.ISAROMATIC)){
     // handle aromatic flag on this chem object
 }
 

Specified by:

getFlag in interface IChemObject

Overrides:

getFlag in class ChemObject

Parameters:

flagType - flag to retrieve the value of

Returns:

true if the flag flag_type is set

See Also:

IChemObject.setFlag(int, boolean), CDKConstants

addProperties

public void addProperties(Map<Object,Object> properties)

Sets the properties of this object.

Specified by:

addProperties in interface IChemObject

Overrides:

addProperties in class ChemObject

Parameters:

properties - a Hashtable specifying the property values

See Also:

ChemObject.getProperties()

setFlags

public void setFlags(boolean[] flagsNew)

Sets the whole set of flags.

Specified by:

setFlags in interface IChemObject

Overrides:

setFlags in class ChemObject

Parameters:

flagsNew - the new flags.

See Also:

ChemObject.getFlags()

getFlags

public boolean[] getFlags()

Returns the whole set of flags.

Specified by:

getFlags in interface IChemObject

Overrides:

getFlags in class ChemObject

Returns:

the flags.

See Also:

ChemObject.setFlags(boolean[])

clone

public Object clone()
             throws CloneNotSupportedException

Clones this ChemModel and its content.

Specified by:

clone in interface IChemObject

Overrides:

clone in class ChemModel

Returns:

The cloned object

Throws:

CloneNotSupportedException - if the IChemObject cannot be cloned

getBuilder

public IChemObjectBuilder getBuilder()

Returns a IChemObjectBuilder for the data classes that extend this class.

Specified by:

getBuilder in interface ICDKObject

Overrides:

getBuilder in class ChemObject

Returns:

The IChemObjectBuilder matching this ICDKObject

getMoleculeSet

public IAtomContainerSet getMoleculeSet()

Returns the MoleculeSet of this ChemModel.

Specified by:

getMoleculeSet in interface IChemModel

Overrides:

getMoleculeSet in class ChemModel

Returns:

The MoleculeSet of this ChemModel

See Also:

ChemModel.setMoleculeSet(org.openscience.cdk.interfaces.IAtomContainerSet)

setMoleculeSet

public void setMoleculeSet(IAtomContainerSet setOfMolecules)

Sets the MoleculeSet of this ChemModel.

Specified by:

setMoleculeSet in interface IChemModel

Overrides:

setMoleculeSet in class ChemModel

Parameters:

setOfMolecules - the content of this model

See Also:

ChemModel.getMoleculeSet()

getRingSet

public IRingSet getRingSet()

Returns the RingSet of this ChemModel.

Specified by:

getRingSet in interface IChemModel

Overrides:

getRingSet in class ChemModel

Returns:

the ringset of this model

See Also:

ChemModel.setRingSet(org.openscience.cdk.interfaces.IRingSet)

setRingSet

public void setRingSet(IRingSet ringSet)

Sets the RingSet of this ChemModel.

Specified by:

setRingSet in interface IChemModel

Overrides:

setRingSet in class ChemModel

Parameters:

ringSet - the content of this model

See Also:

ChemModel.getRingSet()

getCrystal

public ICrystal getCrystal()

Gets the Crystal contained in this ChemModel.

Specified by:

getCrystal in interface IChemModel

Overrides:

getCrystal in class ChemModel

Returns:

The crystal in this model

See Also:

ChemModel.setCrystal(org.openscience.cdk.interfaces.ICrystal)

setCrystal

public void setCrystal(ICrystal crystal)

Sets the Crystal contained in this ChemModel.

Specified by:

setCrystal in interface IChemModel

Overrides:

setCrystal in class ChemModel

Parameters:

crystal - the Crystal to store in this model

See Also:

ChemModel.getCrystal()

getReactionSet

public IReactionSet getReactionSet()

Gets the ReactionSet contained in this ChemModel.

Specified by:

getReactionSet in interface IChemModel

Overrides:

getReactionSet in class ChemModel

Returns:

The ReactionSet in this model

See Also:

ChemModel.setReactionSet(org.openscience.cdk.interfaces.IReactionSet)

setReactionSet

public void setReactionSet(IReactionSet sor)

Sets the ReactionSet contained in this ChemModel.

Specified by:

setReactionSet in interface IChemModel

Overrides:

setReactionSet in class ChemModel

Parameters:

sor - the ReactionSet to store in this model

See Also:

ChemModel.getReactionSet()

isEmpty

public boolean isEmpty()

Returns true if this ChemModel is empty.

Specified by:

isEmpty in interface IChemModel

Overrides:

isEmpty in class ChemModel

Returns:

a boolean indicating if this model has no content