org.openscience.cdk.isomorphism.matchers

Class QueryChemObject

java.lang.Object

org.openscience.cdk.isomorphism.matchers.QueryChemObject

All Implemented Interfaces:

Cloneable, ICDKObject, IChemObject

Direct Known Subclasses:

QueryAtom, QueryAtomContainer, QueryBond, RGroupQuery

public class QueryChemObject
extends Object
implements IChemObject

Source code:

master

Belongs to CDK module:

isomorphism

Constructor Summary

Constructors

Constructor and Description
QueryChemObject(IChemObjectBuilder builder)

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()
IChemObjectBuilder	getBuilder()
boolean	getFlag(int mask)
boolean[]	getFlags()
Short	getFlagValue()
String	getID() Returns the identifier (ID) of this object.
int	getListenerCount() Returns the number of ChemObjectListeners registered with this object.
boolean	getNotification()
Map<Object,Object>	getProperties() Returns a Map with the IChemObject's properties.
<T> T	getProperty(Object description) Returns a property for the IChemObject.
<T> T	getProperty(Object description, Class<T> c)
boolean	matches(IAtom atom)
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	setFlag(int mask, boolean value)
void	setFlags(boolean[] flagsNew)
void	setID(String identifier) Sets the identifier (ID) of this object.
void	setNotification(boolean bool)
void	setProperties(Map<Object,Object> properties)
void	setProperty(Object description, Object property) Sets a property for a IChemObject.

Methods inherited from class java.lang.Object

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

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

toString

Constructor Detail

QueryChemObject

public QueryChemObject(IChemObjectBuilder builder)

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

Parameters:

col - the ChemObjectListener

See Also:

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

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

Parameters:

col - The ChemObjectListener to be removed

See Also:

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

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

Parameters:

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

setProperty

public void setProperty(Object description,
                        Object property)

Sets a property for a IChemObject.

Specified by:

setProperty in interface IChemObject

Parameters:

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

property - An object with the property itself

See Also:

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

removeProperty

public void removeProperty(Object description)

Removes a property for a IChemObject.

Specified by:

removeProperty in interface IChemObject

Parameters:

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

See Also:

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

getProperty

public <T> T getProperty(Object description)

Returns a property for the IChemObject.

Specified by:

getProperty in interface IChemObject

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:

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

getProperty

public <T> T getProperty(Object description,
                         Class<T> c)

Specified by:

getProperty in interface IChemObject

getProperties

public Map<Object,Object> getProperties()

Returns a Map with the IChemObject's properties.

Specified by:

getProperties in interface IChemObject

Returns:

The object's properties as an Hashtable

See Also:

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

Returns:

a String representing the ID value

See Also:

setID(java.lang.String)

setID

public void setID(String identifier)

Sets the identifier (ID) of this object.

Specified by:

setID in interface IChemObject

Parameters:

identifier - a String representing the ID value

See Also:

getID()

setFlag

public void setFlag(int mask,
                    boolean value)

Specified by:

setFlag in interface IChemObject

getFlag

public boolean getFlag(int mask)

Specified by:

getFlag in interface IChemObject

setProperties

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

Specified by:

setProperties in interface IChemObject

addProperties

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

Sets the properties of this object.

Specified by:

addProperties in interface IChemObject

Parameters:

properties - a Hashtable specifying the property values

See Also:

getProperties()

setFlags

public void setFlags(boolean[] flagsNew)

Specified by:

setFlags in interface IChemObject

getFlags

public boolean[] getFlags()

Specified by:

getFlags in interface IChemObject

getFlagValue

public Short getFlagValue()

Specified by:

getFlagValue in interface IChemObject

setNotification

public void setNotification(boolean bool)

Specified by:

setNotification in interface IChemObject

getNotification

public boolean getNotification()

Specified by:

getNotification in interface IChemObject

getBuilder

public IChemObjectBuilder getBuilder()

Specified by:

getBuilder in interface ICDKObject

matches

public boolean matches(IAtom atom)

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface IChemObject

Overrides:

clone in class Object

Throws:

CloneNotSupportedException