Class MmtfActions
- java.lang.Object
-
- org.biojava.nbio.structure.io.mmtf.MmtfActions
-
public class MmtfActions extends Object
A class of functions for reading and writing Biojava structures using MMTF- Author:
- Anthony Bradley
-
-
Constructor Summary
Constructors Constructor Description MmtfActions()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Structure
readFromFile(Path filePath)
Get a Structure object from a mmtf file.static Structure
readFromInputStream(InputStream inStream)
Read a Biojava structure from anInputStream
static Structure
readFromWeb(String pdbId)
Get a Biojava structure from the mmtf REST service.static void
writeToFile(Structure structure, Path path)
Write a Structure object to a file.static void
writeToOutputStream(Structure structure, OutputStream outputStream)
Write a Structure object to anOutputStream
-
-
-
Constructor Detail
-
MmtfActions
public MmtfActions()
-
-
Method Detail
-
readFromFile
public static Structure readFromFile(Path filePath) throws IOException
Get a Structure object from a mmtf file.- Parameters:
filePath
- the mmtf file- Returns:
- a Structure object relating to the input byte array.
- Throws:
IOException
-
writeToFile
public static void writeToFile(Structure structure, Path path) throws IOException
Write a Structure object to a file.- Parameters:
structure
- the Structure to writepath
- the file to write- Throws:
IOException
-
writeToOutputStream
public static void writeToOutputStream(Structure structure, OutputStream outputStream) throws IOException
Write a Structure object to anOutputStream
- Parameters:
structure
- the Structure to writeoutputStream
- theOutputStream
to write to- Throws:
IOException
- an error transferring the byte[]
-
readFromWeb
public static Structure readFromWeb(String pdbId) throws IOException
Get a Biojava structure from the mmtf REST service.- Parameters:
pdbId
- the PDB code of the required structure- Returns:
- a Structure object relating to the input byte array
- Throws:
IOException
-
readFromInputStream
public static Structure readFromInputStream(InputStream inStream) throws IOException
Read a Biojava structure from anInputStream
- Parameters:
inStream
- theInputStream
to read from- Returns:
- the parsed
Structure
- Throws:
IOException
-
-