org.openscience.cdk.io

Class MDLRXNReader

java.lang.Object

org.openscience.cdk.io.ChemObjectIO

org.openscience.cdk.io.DefaultChemObjectReader

org.openscience.cdk.io.MDLRXNReader

All Implemented Interfaces:

Closeable, AutoCloseable, IChemObjectIO, IChemObjectReader, ISimpleChemObjectReader

public class MDLRXNReader
extends DefaultChemObjectReader

Reads a molecule from an MDL RXN file [Dalby, A. and Nourse, J. G. and Hounshell, W. D. and Gushurst, A. K. and Grier, D. L. and Leland, B. A. and Laufer, J., Description of Several Chemical Structure File Formats Used by Computer Programs Developed at Molecular Design Limited, Journal of Chemical Information and Computer Sciences, 1992, 32:244-255].

Author:

Egon Willighagen

Source code:

master

Belongs to CDK module:

io

Keywords:

file format, MDL RXN

Created on:

2003-07-24

Nested Class Summary

Nested classes/interfaces inherited from interface org.openscience.cdk.io.IChemObjectReader

IChemObjectReader.Mode

Field Summary

Fields inherited from class org.openscience.cdk.io.DefaultChemObjectReader

errorHandler, mode

Constructor Summary

Constructors

Constructor and Description
MDLRXNReader()
MDLRXNReader(InputStream input)
MDLRXNReader(InputStream input, IChemObjectReader.Mode mode)
MDLRXNReader(Reader in) Constructs a new MDLReader that can read Molecule from a given Reader.
MDLRXNReader(Reader in, IChemObjectReader.Mode mode)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(Class<? extends IChemObject> classObject) Returns whether the given IChemObject can be read or written.
boolean	accepts(IChemObject object)
void	close() Closes this IChemObjectIO's resources.
IResourceFormat	getFormat() Returns the IResourceFormat class for this IO class.
<T extends IChemObject> T	read(T object) Takes an object which subclasses IChemObject, e.g.Molecule, and will read this (from file, database, internet etc).
void	setReader(InputStream input) Sets the InputStream from which this ChemObjectReader should read the contents.
void	setReader(Reader input) Sets the Reader from which this ChemObjectReader should read the contents.

Methods inherited from class org.openscience.cdk.io.DefaultChemObjectReader

fireFrameRead, handleError, handleError, handleError, handleError, setErrorHandler, setReaderMode

Methods inherited from class org.openscience.cdk.io.ChemObjectIO

addChemObjectIOListener, addSetting, addSettings, fireIOSettingQuestion, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openscience.cdk.io.IChemObjectIO

addChemObjectIOListener, addSetting, addSettings, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListener

Constructor Detail

MDLRXNReader

public MDLRXNReader(Reader in)

Constructs a new MDLReader that can read Molecule from a given Reader.

Parameters:

in - The Reader to read from

MDLRXNReader

public MDLRXNReader(Reader in,
            IChemObjectReader.Mode mode)

MDLRXNReader

public MDLRXNReader(InputStream input)

MDLRXNReader

public MDLRXNReader(InputStream input,
            IChemObjectReader.Mode mode)

MDLRXNReader

public MDLRXNReader()

Method Detail

getFormat

public IResourceFormat getFormat()

Description copied from interface: IChemObjectIO

Returns the IResourceFormat class for this IO class.

setReader

public void setReader(Reader input)
               throws CDKException

Description copied from interface: IChemObjectReader

Sets the Reader from which this ChemObjectReader should read the contents.

Throws:

CDKException

setReader

public void setReader(InputStream input)
               throws CDKException

Description copied from interface: IChemObjectReader

Sets the InputStream from which this ChemObjectReader should read the contents.

Throws:

CDKException

accepts

public boolean accepts(Class<? extends IChemObject> classObject)

Description copied from interface: IChemObjectIO

Returns whether the given IChemObject can be read or written.

Parameters:

classObject - IChemObject of which is tested if it can be handled.

Returns:

true, if the IChemObject can be handled.

read

public <T extends IChemObject> T read(T object)
                           throws CDKException

Takes an object which subclasses IChemObject, e.g.Molecule, and will read this (from file, database, internet etc). If the specific implementation does not support a specific IChemObject it will throw an Exception.

Parameters:

object - The object that subclasses IChemObject

Returns:

The IChemObject read

Throws:

CDKException

accepts

public boolean accepts(IChemObject object)

close

public void close()
           throws IOException

Description copied from interface: IChemObjectIO

Closes this IChemObjectIO's resources.

Throws:

IOException - when the wrapper IO class cannot be closed.