Interface FovData

  • All Known Implementing Classes:
    X3fData, X3iData

    public interface FovData
    Interface for representing the data and metadata contained in FOV[b|i] data (X3F|X3I) files.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long getDataSize()
      Returns the size of the data source in bytes.
      long getDirectoryPointerLocation()
      Returns the file offset in bytes from the beginning of the file where the FOV[b|i] directory pointer is located or -1, if it could not be found.
      long getDirectoryPointerValue()
      Returns the value of the FOV[b|i] directory pointer.
      boolean isParsedSuccessfully()
      Returns true, if the parser could read the FOV[b|i] data without problems.
      boolean isRecoverable()
      Returns true, if a possibly corrupted file is recoverable.
      boolean isRecoveryMode()
      Returns true, if a recovery parser was used, and not the standard parser.
    • Method Detail

      • getDataSize

        long getDataSize()
        Returns the size of the data source in bytes. If this data structure is created by a recovery parser, and the full FOV[b|i] data is present plus some unneccessary data appended, this value will indicate the size of the FOV[b|i] data. That is it may e.g. be smaller than the size of the file it is read from. In case of an error -1 might be returned.
        Returns:
        the size of the FOV[b|i] data in bytes
      • getDirectoryPointerLocation

        long getDirectoryPointerLocation()
        Returns the file offset in bytes from the beginning of the file where the FOV[b|i] directory pointer is located or -1, if it could not be found.
        Returns:
        the file offset where the FOV[b|i] directory pointer is located
      • getDirectoryPointerValue

        long getDirectoryPointerValue()
        Returns the value of the FOV[b|i] directory pointer. That is the offset in bytes from the beginning of the file of the FOV[b|i] directory section.
        Returns:
        the value of the FOV[b|i] directory pointer
      • isParsedSuccessfully

        boolean isParsedSuccessfully()
        Returns true, if the parser could read the FOV[b|i] data without problems. That is, the FOV[b|i] header and FOV[b|i] directory could be parsed according to the specification without an error occuring.
        Returns:
        true, if the parser could read the FOV[b|i] data successfully
      • isRecoverable

        boolean isRecoverable()
        Returns true, if a possibly corrupted file is recoverable.
        Returns:
        true, if a possibly corrupted file is recoverable
      • isRecoveryMode

        boolean isRecoveryMode()
        Returns true, if a recovery parser was used, and not the standard parser.
        Returns:
        true, if a recovery parser was used