org.openscience.cdk.io.formats

Class CTXFormat

java.lang.Object

org.openscience.cdk.io.formats.AbstractResourceFormat

org.openscience.cdk.io.formats.CTXFormat

All Implemented Interfaces:

IChemFormat, IChemFormatMatcher, IResourceFormat

public class CTXFormat
extends AbstractResourceFormat
implements IChemFormatMatcher

Source code:

master

Belongs to CDK module:

ioformats

Nested Class Summary

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

IChemFormatMatcher.MatchResult

Field Summary

Fields inherited from interface org.openscience.cdk.io.formats.IChemFormatMatcher

NO_MATCH

Constructor Summary

Constructors

Constructor and Description
CTXFormat()

Method Summary

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) Check whether a given line at a specified position (line number) could belong to this format.
IChemFormatMatcher.MatchResult	matches(List<String> lines) Simple implementation, runs the lines one-by-one through matches(int, String) and returns true if any line matches.

Methods inherited from class org.openscience.cdk.io.formats.AbstractResourceFormat

equals, hashCode

Methods inherited from class java.lang.Object

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

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

matches

Constructor Detail

CTXFormat

public CTXFormat()

Method Detail

getInstance

public static IResourceFormat getInstance()

getFormatName

public String getFormatName()

Returns a one-lined format name of the format.

Specified by:

getFormatName in interface IResourceFormat

getMIMEType

public String getMIMEType()

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

public String getPreferredNameExtension()

Returns the preferred resource name extension.

Specified by:

getPreferredNameExtension in interface IResourceFormat

getNameExtensions

public String[] getNameExtensions()

Returns an array of common resource name extensions.

Specified by:

getNameExtensions in interface IResourceFormat

getReaderClassName

public String getReaderClassName()

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

public String getWriterClassName()

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)

Check whether a given line at a specified position (line number) could belong to this format.

Parameters:

lineNumber - the line number of line

line - the contents at the given lineNumber

Returns:

this line in this position could indicate a format match

isXMLBased

public boolean isXMLBased()

Indicates if the format is an XML-based language.

Specified by:

isXMLBased in interface IResourceFormat

Returns:

if the format is XML-based.

getSupportedDataFeatures

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

Specified by:

getSupportedDataFeatures in interface IChemFormat

See Also:

DataFeatures

getRequiredDataFeatures

public int getRequiredDataFeatures()

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

matches

public final IChemFormatMatcher.MatchResult matches(List<String> lines)

Simple implementation, runs the lines one-by-one through matches(int, String) and returns true if any line matches.

Specified by:

matches in interface IChemFormatMatcher

Parameters:

lines - lines of the input to be checked

Returns:

runs the lines