Package org.codice.alliance.imaging.nitf.api

Interface NitfParserService

public interface NitfParserService

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    endNitfSegmentsFlow(org.codice.imaging.nitf.fluent.NitfSegmentsFlow nitfSegmentsFlow)
     
    org.codice.imaging.nitf.fluent.NitfSegmentsFlow
    parseNitf(File nitfFile, Boolean allData)
     
    org.codice.imaging.nitf.fluent.NitfSegmentsFlow
    parseNitf(InputStream inputStream, Boolean allData)
     

  • Method Details

    • parseNitf

      org.codice.imaging.nitf.fluent.NitfSegmentsFlow parseNitf(InputStream inputStream, Boolean allData) throws org.codice.imaging.nitf.core.common.NitfFormatException
      Parameters:
      inputStream - an InputStream containing the NITF to be parsed.
      allData - if 'true', then image data will be included in the parsed result. If 'false', then that data will be skipped, saving heap space.
      Returns:
      a NitfSegmentsFlow object containing the parsed NITF data.
      Throws:
      org.codice.imaging.nitf.core.common.NitfFormatException - when 'inputStream' can't be successfully parsed.

    • parseNitf

      org.codice.imaging.nitf.fluent.NitfSegmentsFlow parseNitf(File nitfFile, Boolean allData) throws org.codice.imaging.nitf.core.common.NitfFormatException, FileNotFoundException
      Parameters:
      nitfFile - a file handle to the NITF to be parsed.
      allData - if 'true', then image data will be included in the parsed result. If 'false', then that data will be skipped, saving heap space.
      Returns:
      a NitfSegmentsFlow object containing the parsed NITF data.
      Throws:
      FileNotFoundException - when 'nitfFile' doesn't exist.
      org.codice.imaging.nitf.core.common.NitfFormatException - when 'nitfFile' can't be successfully parsed.

    • endNitfSegmentsFlow

      void endNitfSegmentsFlow(org.codice.imaging.nitf.fluent.NitfSegmentsFlow nitfSegmentsFlow)
      Parameters:
      nitfSegmentsFlow - - the NitfSegmentsFlow object to end. This method call will delete any temp files created by this route.