Package org.biojava.nbio.structure.io

Interface StructureProvider

All Known Subinterfaces:

StructureIOFile

All Known Implementing Classes:

BcifFileReader, CifFileReader, LocalPDBDirectory, MMTFFileReader, PDBFileReader

public interface StructureProvider

A class that can provide a protein structure object from somewhere.

Since:

3.2

Author:

Andreas Prlic

Method Summary

Modifier and Type	Method	Description
FileParsingParameters	getFileParsingParameters()	Get the parameters that should be used for file parsing
Structure	getStructureById(String pdbId)	Get the structure for a PDB ID
Structure	getStructureById(PdbId pdbId)	Get the structure for a PDB ID
void	setFileParsingParameters(FileParsingParameters params)	Set the parameters that should be used for file parsing

Method Details

getStructureById

Structure getStructureById(String pdbId)
                    throws StructureException,
IOException

Get the structure for a PDB ID

Parameters:

pdbId -

Returns:

Throws:

StructureException

IOException

getStructureById

Structure getStructureById(PdbId pdbId)
                    throws StructureException,
IOException

Get the structure for a PDB ID

Parameters:

pdbId -

Returns:

Throws:

StructureException

IOException

setFileParsingParameters

void setFileParsingParameters(FileParsingParameters params)

Set the parameters that should be used for file parsing

Parameters:

params - FileParsingParameters

getFileParsingParameters

FileParsingParameters getFileParsingParameters()

Get the parameters that should be used for file parsing

Returns:

the FileParsingParameters that are configuring the behavior of the parser