de.bioforscher.singa.structure.parser.pdb.structures

Class StructureParser.SingleParser

java.lang.Object

de.bioforscher.singa.structure.parser.pdb.structures.StructureParser.SingleParser

Enclosing class:

StructureParser

public static class StructureParser.SingleParser
extends Object

This parser should be used if you require only a single structure. If more structures should be parsed at once, the MultiParser grants more functionality and speed improvements.

Method Summary

Modifier and Type	Method and Description
Structure	parse() Parses the structure as specifies during teh selection process and returns is,
StructureParser.SingleParser	setOptions(StructureParserOptions options) Sets the StructureParserOptions.

Methods inherited from class java.lang.Object

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

Method Detail

setOptions

public StructureParser.SingleParser setOptions(StructureParserOptions options)

Sets the StructureParserOptions.

Parameters:

options - The options.

Returns:

The parser with the given options.

parse

public Structure parse()
                throws StructureParserException

Parses the structure as specifies during teh selection process and returns is,

Returns:

The structures.

Throws:

StructureParserException - if the structure could not be parsed as specified during the selection.