org.openscience.cdk.io.formats

Interface IChemFormat

All Superinterfaces:

IResourceFormat

All Known Subinterfaces:

IChemFormatMatcher

public interface IChemFormat
extends IResourceFormat

This class is the interface that all ChemFormat's should implement.

Author:

Egon Willighagen <egonw@sci.kun.nl>

Source code:

master

Belongs to CDK module:

ioformats

Created on:

2004-10-25

Method Summary

Modifier and Type	Method and Description
String	getReaderClassName() Returns the class name of the CDK Reader for this format.
int	getRequiredDataFeatures() Returns an integer indicating the data features that this format requires.
int	getSupportedDataFeatures() Returns an integer indicating the data features that this format supports.
String	getWriterClassName() Returns the class name of the CDK Writer for this format.

Methods inherited from interface org.openscience.cdk.io.formats.IResourceFormat

getFormatName, getMIMEType, getNameExtensions, getPreferredNameExtension, isXMLBased

Method Detail

getReaderClassName

String getReaderClassName()

Returns the class name of the CDK Reader for this format.

Returns:

null if no CDK Reader is available.

getWriterClassName

String getWriterClassName()

Returns the class name of the CDK Writer for this format.

Returns:

null if no CDK Writer is available.

getSupportedDataFeatures

int getSupportedDataFeatures()

Returns an integer indicating the data features that this format supports. The integer is composed as explained in DataFeatures. May be set to DataFeatures.NONE as default.

See Also:

org.openscience.cdk.tools.DataFeatures

getRequiredDataFeatures

int getRequiredDataFeatures()

Returns an integer indicating the data features that this format requires. For example, the XYZ format requires 3D coordinates.

See Also:

org.openscience.cdk.tools.DataFeatures