Package org.rcsb.strucmotif.io

Interface StructureDataProvider

All Known Implementing Classes:
StructureDataProviderImpl
public interface StructureDataProvider
Access structure data.

  • Method Details

    • initializeRenumberedStructureCache

      void initializeRenumberedStructureCache() throws IOException
      If `strucmotif.in-memory-strategy` is active: Initialize caching by reading all structures and keeping them in memory for fast access.
      Throws:
      IOException - reading of structure data failed

    • readFromInputStream

      Structure readFromInputStream(InputStream inputStream)
      Read everything from an input stream.
      Parameters:
      inputStream - the source of data, assumed to be following the mmCIF schema
      Returns:
      the corresponding Structure

    • readRenumbered

      Structure readRenumbered(String structureIdentifier)
      Read a renumbered structure entirely.
      Parameters:
      structureIdentifier - the structure to read
      Returns:
      the corresponding Structure

    • readOriginal

      Structure readOriginal(String structureIdentifier)
      Read a selected range from an original structure.
      Parameters:
      structureIdentifier - the structure to read
      Returns:
      the corresponding Structure

    • readSome

      Structure readSome(String structureIdentifier)
      Read some structure entirely.
      Parameters:
      structureIdentifier - the structure to read
      Returns:
      the corresponding Structure

    • writeRenumbered

      void writeRenumbered(String structureIdentifier, org.rcsb.cif.schema.mm.MmCifFile mmCifFile)
      Write a renumbered structure.
      Parameters:
      structureIdentifier - the structure identifier to write
      mmCifFile - the data source

    • deleteRenumbered

      void deleteRenumbered(String structureIdentifier)
      Drop information on a renumbered structure.
      Parameters:
      structureIdentifier - the structure identifier to remove

    • getOriginalInputStream

      InputStream getOriginalInputStream(String structureIdentifier)
      Acquire the input stream of an original structure.
      Parameters:
      structureIdentifier - the structure identifier to read
      Returns:
      the corresponding input stream