Package org.apache.tika.detect.microsoft
Class POIFSContainerDetector
java.lang.Object
org.apache.tika.detect.microsoft.POIFSContainerDetector
- All Implemented Interfaces:
Serializable
,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
Modifier and TypeFieldDescriptionstatic final MediaType
Some other kind of embedded document, in a CompObj container within another OLE2 documentstatic final MediaType
static final MediaType
Microsoft Wordstatic final MediaType
TIKA-3666 MSOffice or other file encrypted with DRM in an OLE containerstatic final MediaType
static final MediaType
General embedded document type within an OLE2 containerstatic final MediaType
Microsoft Projectstatic final MediaType
Equation embedded in Office docsstatic final MediaType
Graph/Charts embedded in PowerPoint and Excelstatic final MediaType
Microsoft Outlookstatic final String
static final MediaType
The OLE base file formatstatic final MediaType
An OLE10 Native embedded document within another OLE2 documentstatic final MediaType
The protected OOXML base file formatstatic final MediaType
Microsoft PowerPointstatic final MediaType
Microsoft Publisherstatic final MediaType
StarOffice Drawstatic final MediaType
StarOffice Calcstatic final MediaType
StarOffice Impressstatic final MediaType
StarOffice Writerstatic final MediaType
SolidWorks CAD filestatic final MediaType
Microsoft Visiostatic final MediaType
Microsoft Worksstatic final MediaType
Microsoft Works Spreadsheet 7.0static final MediaType
Microsoft Excel -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondetect
(InputStream input, Metadata metadata) Detects the content type of the given input document.static MediaType
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 todetect(InputStream, Metadata)
, and there is not an underlying file, this detector will spool up tomarkLimit
to disk.
-
Field Details
-
OLE
The OLE base file format -
OOXML_PROTECTED
The protected OOXML base file format -
DRM_ENCRYPTED
TIKA-3666 MSOffice or other file encrypted with DRM in an OLE container -
GENERAL_EMBEDDED
General embedded document type within an OLE2 container -
OLE10_NATIVE
An OLE10 Native embedded document within another OLE2 document -
COMP_OBJ
Some other kind of embedded document, in a CompObj container within another OLE2 document -
MS_GRAPH_CHART
Graph/Charts embedded in PowerPoint and Excel -
MS_EQUATION
Equation embedded in Office docs -
OCX_NAME
- See Also:
-
XLS
Microsoft Excel -
DOC
Microsoft Word -
PPT
Microsoft PowerPoint -
PUB
Microsoft Publisher -
VSD
Microsoft Visio -
WPS
Microsoft Works -
XLR
Microsoft Works Spreadsheet 7.0 -
MSG
Microsoft Outlook -
MPP
Microsoft Project -
SDC
StarOffice Calc -
SDA
StarOffice Draw -
SDD
StarOffice Impress -
SDW
StarOffice Writer -
SLDWORKS
SolidWorks CAD file -
ESRI_LAYER
-
DGN_8
-
-
Constructor Details
-
POIFSContainerDetector
public POIFSContainerDetector()
-
-
Method Details
-
detect
public static MediaType detect(Set<String> anyCaseNames, 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 rootDirectoryEntry
of that file for best results. The entry can be given as a second, optional argument. Following 2.6.1 of MS-CFB , The detection is performed on case insensitive entry names.- Parameters:
anyCaseNames
-root
-- Returns:
-
setMarkLimit
public void setMarkLimit(int markLimit) If a TikaInputStream is passed in todetect(InputStream, Metadata)
, and there is not an underlying file, this detector will spool up tomarkLimit
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 returnOLE
(orMediaType.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
Description copied from interface:Detector
Detects the content type of the given input document. Returnsapplication/octet-stream
if the type of the document can not be detected.If the document input stream is not available, then the first argument may be
null
. Otherwise the detector may read bytes from the start of the stream to help in type detection. The given stream is guaranteed to support themark feature
and the detector is expected tomark
the stream before reading any bytes from it, and toreset
the stream before returning. The stream must not be closed by the detector.The given input metadata is only read, not modified, by the detector.
- Specified by:
detect
in interfaceDetector
- Parameters:
input
- document input stream, ornull
metadata
- input metadata for the document- Returns:
- detected media type, or
application/octet-stream
- Throws:
IOException
- if the document input stream could not be read
-