Interface ContainerExtractor

All Superinterfaces:
All Known Implementing Classes:

public interface ContainerExtractor extends Serializable
Tika container extractor interface. Container Extractors provide access to the embedded resources within container formats such as .zip and .doc
  • Method Details

    • isSupported

      boolean isSupported(TikaInputStream input) throws IOException
      Is this Container Extractor able to process the supplied container?
      Apache Tika 0.8
    • extract

      void extract(TikaInputStream stream, ContainerExtractor recurseExtractor, EmbeddedResourceHandler handler) throws IOException, TikaException
      Processes a container file, and extracts all the embedded resources from within it.

      The EmbeddedResourceHandler you supply will be called for each embedded resource in the container. It is up to you whether you process the contents of the resource or not.

      The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

      If required, nested containers (such as a .docx within a .zip) can automatically be recursed into, and processed inline. If no recurseExtractor is given, the nested containers will be treated as with any other embedded resources.

      stream - the document stream (input)
      recurseExtractor - the extractor to use on any embedded containers
      handler - handler for the embedded files (output)
      IOException - if the document stream could not be read
      TikaException - if the container could not be parsed
      Apache Tika 0.8