org.openscience.cdk

Class Mapping

java.lang.Object

org.openscience.cdk.ChemObject

org.openscience.cdk.Mapping

All Implemented Interfaces:

Serializable, Cloneable, ICDKObject, IChemObject, IMapping

Direct Known Subclasses:

DebugMapping

public class Mapping
extends ChemObject
implements Serializable, Cloneable, IMapping

A Mapping is an relation between two ChemObjects in a non-chemical entity. It is not a Bond, nor a Association, merely a relation. An example of such a mapping, is the mapping between corresponding atoms in a Reaction.

Author:

Egon Willighagen

See Also:

Serialized Form

Source code:

master

Belongs to CDK module:

data

Keywords:

reaction, atom mapping

Created on:

2003-08-16

Constructor Summary

Constructors

Constructor and Description
Mapping(IChemObject objectOne, IChemObject objectTwo) Constructs an unconnected lone pair.

Method Summary

Modifier and Type	Method and Description
Object	clone() Clones this Mapping and the mapped IChemObjects.
IChemObject	getChemObject(int pos) Retrieves the first or second of the related IChemObjects.
Iterable<IChemObject>	relatedChemObjects() Returns an Iterable to the two IChemObjects.

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, toString, wait, wait, wait

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.ICDKObject

getBuilder

Constructor Detail

Mapping

public Mapping(IChemObject objectOne,
               IChemObject objectTwo)

Constructs an unconnected lone pair.

Parameters:

objectOne - The first IChemObject of the mapping

objectTwo - The second IChemObject of the mapping

Method Detail

relatedChemObjects

public Iterable<IChemObject> relatedChemObjects()

Returns an Iterable to the two IChemObjects. Iterable.remove() is not implemented.

Specified by:

relatedChemObjects in interface IMapping

Returns:

An Iterable to two IChemObjects that define the mapping

getChemObject

public IChemObject getChemObject(int pos)

Retrieves the first or second of the related IChemObjects.

Specified by:

getChemObject in interface IMapping

Parameters:

pos - The position of the IChemObject.

Returns:

The IChemObject to retrieve.

clone

public Object clone()
             throws CloneNotSupportedException

Clones this Mapping and the mapped IChemObjects.

Specified by:

clone in interface IChemObject

Overrides:

clone in class ChemObject

Returns:

The cloned object

Throws:

CloneNotSupportedException - if the IChemObject cannot be cloned