org.apache.poi.extractor.ole2

Class OLE2ScratchpadExtractorFactory

java.lang.Object

org.apache.poi.extractor.ole2.OLE2ScratchpadExtractorFactory

All Implemented Interfaces:

ExtractorProvider

public class OLE2ScratchpadExtractorFactory
extends java.lang.Object
implements ExtractorProvider

Scratchpad-specific logic for ExtractorFactory and ExtractorFactory, which permit the other two to run with no Scratchpad jar (though without functionality!)

Note - should not be used standalone, always use via the other two classes

Constructor Summary

Constructors

Constructor and Description
OLE2ScratchpadExtractorFactory()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(FileMagic fm)
POITextExtractor	create(DirectoryNode poifsDir, java.lang.String password) Look for certain entries in the stream, to figure it out what format is desired Note - doesn't check for core-supported formats! Note - doesn't check for OOXML-supported formats
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
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).

Methods inherited from class java.lang.Object

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

Constructor Detail

OLE2ScratchpadExtractorFactory

public OLE2ScratchpadExtractorFactory()

Method Detail

accepts

public boolean accepts(FileMagic fm)

Specified by:

accepts in interface ExtractorProvider

create

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

Description copied from interface: ExtractorProvider

Create Extractor via file

Specified by:

create in interface ExtractorProvider

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

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

Description copied from interface: ExtractorProvider

Create Extractor via InputStream

Specified by:

create in interface ExtractorProvider

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

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

Look for certain entries in the stream, to figure it out what format is desired Note - doesn't check for core-supported formats! Note - doesn't check for OOXML-supported formats

Specified by:

create in interface ExtractorProvider

Parameters:

poifsDir - the directory node to be inspected

password - the password or null if not encrypted

Returns:

the format specific text extractor

Throws:

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

identifyEmbeddedResources

public 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). If there are no embedded documents, you'll get back an empty array. Otherwise, you'll get one open POITextExtractor for each embedded file.

Specified by:

identifyEmbeddedResources in interface ExtractorProvider

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