org.openscience.cdk.io.formats

Class Gaussian03Format

java.lang.Object

org.openscience.cdk.io.formats.Gaussian03Format

All Implemented Interfaces:

IChemFormat, IChemFormatMatcher, IResourceFormat

@TestClass(value="org.openscience.cdk.io.formats.Gaussian03FormatTest")
public class Gaussian03Format
extends Object
implements IChemFormatMatcher

See here.

Belongs to the set:

io-formats

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormatName() Returns a one-lined format name of the format.
static IResourceFormat	getInstance()
String	getMIMEType() Returns the accepted MIME type for this format.
String[]	getNameExtensions() Returns an array of common resource name extensions.
String	getPreferredNameExtension() Returns the preferred resource name extension.
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.
boolean	isXMLBased() Indicates if the format is an XML-based language.
boolean	matches(int lineNumber, String line) Method that checks whether the given line is part of the format read by this reader.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@TestMethod(value="testResourceFormatSet")
public static IResourceFormat getInstance()

getFormatName

@TestMethod(value="testGetFormatName")
public String getFormatName()

Description copied from interface: IResourceFormat

Returns a one-lined format name of the format.

Specified by:

getFormatName in interface IResourceFormat

getMIMEType

@TestMethod(value="testGetMIMEType")
public String getMIMEType()

Description copied from interface: IResourceFormat

Returns the accepted MIME type for this format.

Specified by:

getMIMEType in interface IResourceFormat

Returns:

null if no MIME type has been accepted on

getPreferredNameExtension

@TestMethod(value="testGetPreferredNameExtension")
public String getPreferredNameExtension()

Description copied from interface: IResourceFormat

Returns the preferred resource name extension.

Specified by:

getPreferredNameExtension in interface IResourceFormat

getNameExtensions

@TestMethod(value="testGetNameExtensions")
public String[] getNameExtensions()

Description copied from interface: IResourceFormat

Returns an array of common resource name extensions.

Specified by:

getNameExtensions in interface IResourceFormat

getReaderClassName

@TestMethod(value="testGetReaderClassName")
public String getReaderClassName()

Description copied from interface: IChemFormat

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

Specified by:

getReaderClassName in interface IChemFormat

Returns:

null if no CDK Reader is available.

getWriterClassName

@TestMethod(value="testGetWriterClassName")
public String getWriterClassName()

Description copied from interface: IChemFormat

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

Specified by:

getWriterClassName in interface IChemFormat

Returns:

null if no CDK Writer is available.

matches

public boolean matches(int lineNumber,
              String line)

Description copied from interface: IChemFormatMatcher

Method that checks whether the given line is part of the format read by this reader.

Specified by:

matches in interface IChemFormatMatcher

Parameters:

lineNumber - number of the line

line - line in the file being checked

Returns:

true if the line is of a file format read by this reader

isXMLBased

@TestMethod(value="testIsXMLBased")
public boolean isXMLBased()

Description copied from interface: IResourceFormat

Indicates if the format is an XML-based language.

Specified by:

isXMLBased in interface IResourceFormat

Returns:

if the format is XML-based.

getSupportedDataFeatures

@TestMethod(value="testGetSupportedDataFeatures")
public int getSupportedDataFeatures()

Description copied from interface: IChemFormat

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.

Specified by:

getSupportedDataFeatures in interface IChemFormat

See Also:

DataFeatures

getRequiredDataFeatures

@TestMethod(value="testGetRequiredDataFeatures")
public int getRequiredDataFeatures()

Description copied from interface: IChemFormat

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

Specified by:

getRequiredDataFeatures in interface IChemFormat

See Also:

DataFeatures