org.apache.poi.extractor

Interface ExtractorProvider

All Known Implementing Classes:

MainExtractorFactory, OLE2ScratchpadExtractorFactory, POIXMLExtractorFactory

public interface ExtractorProvider

Method Summary

Modifier and Type	Method and Description
boolean	accepts(FileMagic fm)
POITextExtractor	create(DirectoryNode poifsDir, java.lang.String password) Create Extractor from POIFS node
POITextExtractor	create(java.io.File file, java.lang.String password) Create Extractor via file
POITextExtractor	create(java.io.InputStream inputStream, java.lang.String password) Create Extractor via InputStream
default void	identifyEmbeddedResources(POIOLE2TextExtractor ext, java.util.List<Entry> dirs, java.util.List<java.io.InputStream> nonPOIFS) Returns an array of text extractors, one for each of the embedded documents in the file (if there are any).

Method Detail

accepts

boolean accepts(FileMagic fm)

create

POITextExtractor create(java.io.File file,
                        java.lang.String password)
                 throws java.io.IOException

Create Extractor via file

Parameters:

file - the file

password - the password or null if not encrypted

Returns:

the extractor

Throws:

java.io.IOException - if file can't be read or parsed

create

POITextExtractor create(java.io.InputStream inputStream,
                        java.lang.String password)
                 throws java.io.IOException

Create Extractor via InputStream

Parameters:

inputStream - the stream

password - the password or null if not encrypted

Returns:

the extractor

Throws:

java.io.IOException - if stream can't be read or parsed

create

POITextExtractor create(DirectoryNode poifsDir,
                        java.lang.String password)
                 throws java.io.IOException

Create Extractor from POIFS node

Parameters:

poifsDir - the node

password - the password or null if not encrypted

Returns:

the extractor

Throws:

java.io.IOException - if node can't be parsed

java.lang.IllegalStateException - if processing fails for some other reason, e.g. missing JCE Unlimited Strength Jurisdiction Policy files while handling encrypted files.

identifyEmbeddedResources

default void identifyEmbeddedResources(POIOLE2TextExtractor ext,
                                       java.util.List<Entry> dirs,
                                       java.util.List<java.io.InputStream> nonPOIFS)
                                throws java.io.IOException

Returns an array of text extractors, one for each of the embedded documents in the file (if there are any). If there are no embedded documents, you'll get back an empty array. Otherwise, you'll get one open POITextExtractor for each embedded file.

Parameters:

ext - the extractor holding the directory to start parsing

dirs - a list to be filled with directory references holding embedded

nonPOIFS - a list to be filled with streams which aren't based on POIFS entries

Throws:

java.io.IOException - when the format specific extraction fails because of invalid entires