Package org.apache.tika.detect.ole

Class MiscOLEDetector

java.lang.Object
org.apache.tika.detect.ole.MiscOLEDetector
All Implemented Interfaces:
Serializable, org.apache.tika.detect.Detector
public class MiscOLEDetector extends Object implements org.apache.tika.detect.Detector
A detector that works on a POIFS OLE2 document to figure out exactly what the file is. This should work for all OLE2 documents, whether they are ones supported by POI or not.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.tika.mime.MediaType
    HWP
    Hangul Word Processor (Korean)
    static final org.apache.tika.mime.MediaType
    OLE
    The OLE base file format
    static final org.apache.tika.mime.MediaType
    QUATTROPRO
    Base QuattroPro mime

  • Constructor Summary

    Constructors
    Constructor
    Description
    MiscOLEDetector()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.tika.mime.MediaType
    detect(InputStream input, org.apache.tika.metadata.Metadata metadata)
     
    protected static org.apache.tika.mime.MediaType
    detect(Set<String> names)
    Deprecated.
    Use detect(Set, DirectoryEntry) and pass the root entry of the filesystem whose type is to be detected, as a second argument.
    protected static org.apache.tika.mime.MediaType
    detect(Set<String> names, org.apache.poi.poifs.filesystem.DirectoryEntry root)
    Internal detection of the specific kind of OLE2 document, based on the names of the top-level streams within the file.
    void
    setMarkLimit(int markLimit)
    If a TikaInputStream is passed in to detect(InputStream, Metadata), and there is not an underlying file, this detector will spool up to markLimit to disk.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • OLE

      public static final org.apache.tika.mime.MediaType OLE
      The OLE base file format

    • HWP

      public static final org.apache.tika.mime.MediaType HWP
      Hangul Word Processor (Korean)

    • QUATTROPRO

      public static final org.apache.tika.mime.MediaType QUATTROPRO
      Base QuattroPro mime

  • Constructor Details

    • MiscOLEDetector

      public MiscOLEDetector()

  • Method Details

    • detect

      @Deprecated protected static org.apache.tika.mime.MediaType detect(Set<String> names)
      Deprecated.
      Use detect(Set, DirectoryEntry) and pass the root entry of the filesystem whose type is to be detected, as a second argument.
      Internal detection of the specific kind of OLE2 document, based on the names of the top level streams within the file.

    • detect

      protected static org.apache.tika.mime.MediaType detect(Set<String> names, org.apache.poi.poifs.filesystem.DirectoryEntry root)
      Internal detection of the specific kind of OLE2 document, based on the names of the top-level streams within the file. In some cases the detection may need access to the root DirectoryEntry of that file for best results. The entry can be given as a second, optional argument.
      Parameters:
      names -
      root -
      Returns:

    • setMarkLimit

      public void setMarkLimit(int markLimit)
      If a TikaInputStream is passed in to detect(InputStream, Metadata), and there is not an underlying file, this detector will spool up to markLimit to disk. If the stream was read in entirety (e.g. the spooled file is not truncated), this detector will open the file with POI and perform detection. If the spooled file is truncated, the detector will return OLE (or MediaType.OCTET_STREAM if there's no OLE header).

      As of Tika 1.21, this detector respects the legacy behavior of not performing detection on a non-TikaInputStream.

      Parameters:
      markLimit -

    • detect

      public org.apache.tika.mime.MediaType detect(InputStream input, org.apache.tika.metadata.Metadata metadata) throws IOException
      Specified by:
      detect in interface org.apache.tika.detect.Detector
      Throws:
      IOException