Interface Index

All Known Implementing Classes:
SimpleIndex

public interface Index
This defines an index entry for an individual sequence within a set of indexed files.
Author:
Matthew Pocock
  • Method Summary

    Modifier and Type
    Method
    Description
    The file to retrieve from.
    The ID of the sequence at this position in this file.
    int
    The entry can be slurped out of the file by grabbing length bytes from start.
    long
    Skipping this number of bytes through the file should put the file pointer to the first byte of the sequence.
  • Method Details

    • getFile

      The file to retrieve from.
      Returns:
      the File containing this Sequence
    • getStart

      long getStart()
      Skipping this number of bytes through the file should put the file pointer to the first byte of the sequence.
      Returns:
      the offset within the file
    • getLength

      int getLength()
      The entry can be slurped out of the file by grabbing length bytes from start. If the length can't be read from a store then this method should return -1.
      Returns:
      the length in bytes of this indexed entry
    • getID

      The ID of the sequence at this position in this file.
      Returns:
      the ID of the indexed Sequence