Package org.apache.tika.detect.zip

Class OpenDocumentDetector

java.lang.Object

org.apache.tika.detect.zip.OpenDocumentDetector

All Implemented Interfaces:

Serializable, ZipContainerDetector

public class OpenDocumentDetector
extends Object
implements ZipContainerDetector

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OpenDocumentDetector()

Method Summary

Modifier and Type	Method	Description
org.apache.tika.mime.MediaType	detect(org.apache.commons.compress.archivers.zip.ZipFile zip, org.apache.tika.io.TikaInputStream tis)	If detection is successful, the ZipDetector should set the zip file or OPCPackage in TikaInputStream.setOpenContainer() Implementations should _not_ close the ZipFile
org.apache.tika.mime.MediaType	streamingDetectFinal(StreamingDetectContext detectContext)	After we've finished streaming the zip archive entries, a detector may make a final decision.
org.apache.tika.mime.MediaType	streamingDetectUpdate(org.apache.commons.compress.archivers.zip.ZipArchiveEntry zae, InputStream zis, StreamingDetectContext detectContext)	Try to detect on a specific entry.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenDocumentDetector

public OpenDocumentDetector()

Method Details

detect

public org.apache.tika.mime.MediaType detect(org.apache.commons.compress.archivers.zip.ZipFile zip,
 org.apache.tika.io.TikaInputStream tis)
                                      throws IOException

Description copied from interface: ZipContainerDetector

If detection is successful, the ZipDetector should set the zip file or OPCPackage in TikaInputStream.setOpenContainer() Implementations should _not_ close the ZipFile

Specified by:

detect in interface ZipContainerDetector

Returns:

Throws:

IOException

streamingDetectUpdate

public org.apache.tika.mime.MediaType streamingDetectUpdate(org.apache.commons.compress.archivers.zip.ZipArchiveEntry zae,
 InputStream zis,
 StreamingDetectContext detectContext)
                                                     throws IOException

Description copied from interface: ZipContainerDetector

Try to detect on a specific entry. Detectors are allowed to store state (e.g. "remember what they've seen") in the StreamingDetectContext

Specified by:

streamingDetectUpdate in interface ZipContainerDetector

Returns:

Throws:

IOException

streamingDetectFinal

public org.apache.tika.mime.MediaType streamingDetectFinal(StreamingDetectContext detectContext)

Description copied from interface: ZipContainerDetector

After we've finished streaming the zip archive entries, a detector may make a final decision.

Specified by:

streamingDetectFinal in interface ZipContainerDetector

Returns: