org.biojava.bio.structure.io
Interface StructureProvider

All Known Implementing Classes:

LocalCacheStructureProvider, SandboxStyleStructureProvider

public interface StructureProvider

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

Since:

3.2

Author:

Andreas Prlic

Method Summary

Structure	getBiologicalUnit(String pdbId) get the biological unit for a file
FileParsingParameters	getFileParsingParameters() Get the parameters that should be used for file parsing
Structure	getStructureById(String pdbId) get the structure for a PDB ID
void	setFileParsingParameters(FileParsingParameters params) Set the parameters that should be used for file parsing

Method Detail

getStructureById

Structure getStructureById(String pdbId)
                           throws StructureException,
                                  IOException

get the structure for a PDB ID

Parameters:

pdbId -

Returns:

Throws:

StructureException

IOException

getBiologicalUnit

Structure getBiologicalUnit(String pdbId)
                            throws StructureException,
                                   IOException

get the biological unit for a file

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