Apache POI - Common 5.3.0 · org.apache.poi.extractor.ExtractorFactory

Modifier and Type	Class and Description
private static interface	ExtractorFactory.ProviderMethod
private static class	ExtractorFactory.Singleton

Modifier and Type	Field and Description
private static Boolean	allPreferEventExtractors Should all threads prefer event based over usermodel based extractors?
private static final Logger	LOGGER
public static final String	OOXML_PACKAGE Some OPCPackages are packed in side an OLE2 container.
private final List<ExtractorProvider>	provider
private static final ThreadLocal<Boolean>	threadPreferEventExtractors Should this thread prefer event based over usermodel based extractors?

Access	Constructor and Description
private	ExtractorFactory()

Method Summary

Modifier and Type	Method and Description
public static void	addProvider(ExtractorProvider provider)
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(POIFSFileSystem The file-system which wraps the data of the file. fs) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(POIFSFileSystem The file-system which wraps the data of the file. fs, String The password that is necessary to open the file password) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(InputStream A stream which wraps the data of the file. input) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(InputStream A stream which wraps the data of the file. input, String The password that is necessary to open the file password) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(File The file to read file) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: A POITextExtractor that can be used to fetch text-content of the file. createExtractor(File The file to read file, String The password that is necessary to open the file password) Create an extractor that can be used to read text from the given file.
public static POITextExtractor	Returns: The resulting `POITextExtractor`, an exception is thrown if no TextExtractor can be created for some reason. createExtractor(DirectoryNode The `DirectoryNode` pointing to a document. root) Create the Extractor, if possible.
public static POITextExtractor	Returns: The resulting `POITextExtractor`, an exception is thrown if no TextExtractor can be created for some reason. createExtractor(final DirectoryNode The `DirectoryNode` pointing to a document. root, String The password that is necessary to open the file password) Create the Extractor, if possible.
public static Boolean	Returns: true if event extractors should be preferred in all threads, false otherwise. getAllThreadsPreferEventExtractors() Should all threads prefer event based over usermodel based extractors?
public static POITextExtractor[]	Returns: An array of resulting extractors. Empty if no embedded documents are found. getEmbeddedDocsTextExtractors(POIOLE2TextExtractor The extractor to look at for embedded documents ext) Returns an array of text extractors, one for each of the embedded documents in the file (if there are any).
public static boolean	Returns: If the current thread should use event based extractors. getPreferEventExtractor() Should this thread use event based extractors is available?
public static boolean	Returns: true if event extractors should be preferred in the current thread, false otherwise. getThreadPrefersEventExtractors() Should this thread prefer event based over usermodel based extractors?
public static void	removeProvider(Class<? extends ExtractorProvider> provider)
public static void	removeThreadPrefersEventExtractorsSetting() Clears the setting for this thread made by `setThreadPrefersEventExtractors(boolean)`
public static void	setAllThreadsPreferEventExtractors(Boolean If all threads should prefer event based extractors. preferEventExtractors) Should all threads prefer event based over usermodel based extractors?
public static void	setThreadPrefersEventExtractors(boolean If this threads should prefer event based extractors. preferEventExtractors) Should this thread prefer event based over usermodel based extractors?
private static POITextExtractor	wp(FileMagic fm, ExtractorFactory.ProviderMethod fun)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allPreferEventExtractors	back to summary
private static Boolean allPreferEventExtractors Should all threads prefer event based over usermodel based extractors?

LOGGER	back to summary
private static final Logger LOGGER

OOXML_PACKAGE	back to summary
public static final String OOXML_PACKAGE Some OPCPackages are packed in side an OLE2 container. If encrypted, the `DirectoryNode` is called `"EncryptedPackage"`, otherwise the node is called "Package"

provider	back to summary
private final List<ExtractorProvider> provider

threadPreferEventExtractors	back to summary
private static final ThreadLocal<Boolean> threadPreferEventExtractors Should this thread prefer event based over usermodel based extractors?

ExtractorFactory	back to summary
private ExtractorFactory()

Method Detail

addProvider	back to summary
public static void addProvider(ExtractorProvider provider)

createExtractor	back to summary
public static POITextExtractor createExtractor(POIFSFileSystem fs) throws IOException Create an extractor that can be used to read text from the given file. Parameters fs:POIFSFileSystem The file-system which wraps the data of the file. Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Exceptions IOException: If reading the file-data fails

createExtractor

back to summary

public static POITextExtractor createExtractor(POIFSFileSystem fs) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

fs:POIFSFileSystem: The file-system which wraps the data of the file.

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Exceptions

IOException:: If reading the file-data fails

createExtractor	back to summary
public static POITextExtractor createExtractor(POIFSFileSystem fs, String password) throws IOException Create an extractor that can be used to read text from the given file. Parameters fs:POIFSFileSystem The file-system which wraps the data of the file. password:String The password that is necessary to open the file Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Exceptions IOException: If reading the file-data fails

createExtractor

back to summary

public static POITextExtractor createExtractor(POIFSFileSystem fs, String password) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

fs:POIFSFileSystem: The file-system which wraps the data of the file.
password:String: The password that is necessary to open the file

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Exceptions

IOException:: If reading the file-data fails

createExtractor	back to summary
public static POITextExtractor createExtractor(InputStream input) throws IOException Create an extractor that can be used to read text from the given file. Parameters input:InputStream A stream which wraps the data of the file. Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Exceptions IOException: If reading the file-data fails EmptyFileException: If the given file is empty

createExtractor

back to summary

public static POITextExtractor createExtractor(InputStream input) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

input:InputStream: A stream which wraps the data of the file.

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Exceptions

IOException:: If reading the file-data fails
EmptyFileException:: If the given file is empty

createExtractor	back to summary
public static POITextExtractor createExtractor(InputStream input, String password) throws IOException Create an extractor that can be used to read text from the given file. Parameters input:InputStream A stream which wraps the data of the file. password:String The password that is necessary to open the file Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Exceptions IOException: If reading the file-data fails EmptyFileException: If the given file is empty

createExtractor

back to summary

public static POITextExtractor createExtractor(InputStream input, String password) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

input:InputStream: A stream which wraps the data of the file.
password:String: The password that is necessary to open the file

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Exceptions

IOException:: If reading the file-data fails
EmptyFileException:: If the given file is empty

createExtractor	back to summary
public static POITextExtractor createExtractor(File file) throws IOException Create an extractor that can be used to read text from the given file. Parameters file:File The file to read Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Exceptions IOException: If reading the file-data fails EmptyFileException: If the given file is empty

createExtractor

back to summary

public static POITextExtractor createExtractor(File file) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

file:File: The file to read

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Exceptions

IOException:: If reading the file-data fails
EmptyFileException:: If the given file is empty

createExtractor	back to summary
public static POITextExtractor createExtractor(File file, String password) throws IOException Create an extractor that can be used to read text from the given file. Parameters file:File The file to read password:String The password that is necessary to open the file Returns:POITextExtractor A POITextExtractor that can be used to fetch text-content of the file. Annotations @SuppressWarnings:java:S2095 Exceptions IOException: If reading the file-data fails EmptyFileException: If the given file is empty

createExtractor

back to summary

public static POITextExtractor createExtractor(File file, String password) throws IOException

Create an extractor that can be used to read text from the given file.

Parameters

file:File: The file to read
password:String: The password that is necessary to open the file

Returns:POITextExtractor

A POITextExtractor that can be used to fetch text-content of the file.

Annotations

@SuppressWarnings:java:S2095

Exceptions

IOException:: If reading the file-data fails
EmptyFileException:: If the given file is empty

createExtractor back to summary

createExtractor	back to summary
public static POITextExtractor createExtractor(DirectoryNode root) throws IOException Create the Extractor, if possible. Generally needs the Scratchpad jar. Note that this won't check for embedded OOXML resources either, use `org.apache.poi.ooxml.extractor.POIXMLExtractorFactory` for that. Parameters root:DirectoryNode The `DirectoryNode` pointing to a document. Returns:POITextExtractor The resulting `POITextExtractor`, an exception is thrown if no TextExtractor can be created for some reason. Exceptions IOException: If converting the `DirectoryNode` into a HSSFWorkbook fails OldFileFormatException: If the `DirectoryNode` points to a format of an unsupported version of Excel. IllegalArgumentException: If creating the Extractor fails

public static POITextExtractor createExtractor(DirectoryNode root) throws IOException

Create the Extractor, if possible. Generally needs the Scratchpad jar. Note that this won't check for embedded OOXML resources either, use org.apache.poi.ooxml.extractor.POIXMLExtractorFactory for that.

Parameters

root:DirectoryNode: The DirectoryNode pointing to a document.

Returns:POITextExtractor

The resulting POITextExtractor, an exception is thrown if no TextExtractor can be created for some reason.

Exceptions

IOException:: If converting the DirectoryNode into a HSSFWorkbook fails
OldFileFormatException:: If the DirectoryNode points to a format of an unsupported version of Excel.
IllegalArgumentException:: If creating the Extractor fails

createExtractor back to summary

createExtractor	back to summary
public static POITextExtractor createExtractor(final DirectoryNode root, String password) throws IOException Create the Extractor, if possible. Generally needs the Scratchpad jar. Note that this won't check for embedded OOXML resources either, use `org.apache.poi.ooxml.extractor.POIXMLExtractorFactory` for that. Parameters root:DirectoryNode The `DirectoryNode` pointing to a document. password:String The password that is necessary to open the file Returns:POITextExtractor The resulting `POITextExtractor`, an exception is thrown if no TextExtractor can be created for some reason. Exceptions IOException: If converting the `DirectoryNode` into a HSSFWorkbook fails OldFileFormatException: If the `DirectoryNode` points to a format of an unsupported version of Excel. IllegalArgumentException: If creating the Extractor fails

public static POITextExtractor createExtractor(final DirectoryNode root, String password) throws IOException

Parameters

root:DirectoryNode: The DirectoryNode pointing to a document.
password:String: The password that is necessary to open the file

Returns:POITextExtractor

The resulting POITextExtractor, an exception is thrown if no TextExtractor can be created for some reason.

Exceptions

IOException:: If converting the DirectoryNode into a HSSFWorkbook fails
OldFileFormatException:: If the DirectoryNode points to a format of an unsupported version of Excel.
IllegalArgumentException:: If creating the Extractor fails

getAllThreadsPreferEventExtractors	back to summary
public static Boolean getAllThreadsPreferEventExtractors() Should all threads prefer event based over usermodel based extractors? (usermodel extractors tend to be more accurate, but use more memory) Default is to use the thread level setting, which defaults to false. Returns:Boolean true if event extractors should be preferred in all threads, false otherwise.

getAllThreadsPreferEventExtractors

back to summary

public static Boolean getAllThreadsPreferEventExtractors()

Should all threads prefer event based over usermodel based extractors? (usermodel extractors tend to be more accurate, but use more memory) Default is to use the thread level setting, which defaults to false.

Returns:Boolean: true if event extractors should be preferred in all threads, false otherwise.

getEmbeddedDocsTextExtractors back to summary

getEmbeddedDocsTextExtractors	back to summary
public static POITextExtractor[] getEmbeddedDocsTextExtractors(POIOLE2TextExtractor ext) throws 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:POIOLE2TextExtractor The extractor to look at for embedded documents Returns:POITextExtractor[] An array of resulting extractors. Empty if no embedded documents are found. Exceptions IOException: If converting the `DirectoryNode` into a HSSFWorkbook fails OldFileFormatException: If the `DirectoryNode` points to a format of an unsupported version of Excel. IllegalArgumentException: If creating the Extractor fails

public static POITextExtractor[] getEmbeddedDocsTextExtractors(POIOLE2TextExtractor ext) throws 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:POIOLE2TextExtractor: The extractor to look at for embedded documents

Returns:POITextExtractor[]

An array of resulting extractors. Empty if no embedded documents are found.

Exceptions

IOException:: If converting the DirectoryNode into a HSSFWorkbook fails
OldFileFormatException:: If the DirectoryNode points to a format of an unsupported version of Excel.
IllegalArgumentException:: If creating the Extractor fails

getPreferEventExtractor	back to summary
public static boolean getPreferEventExtractor() Should this thread use event based extractors is available? Checks the all-threads one first, then thread specific. Returns:boolean If the current thread should use event based extractors.

getPreferEventExtractor

back to summary

public static boolean getPreferEventExtractor()

Should this thread use event based extractors is available? Checks the all-threads one first, then thread specific.

Returns:boolean: If the current thread should use event based extractors.

getThreadPrefersEventExtractors	back to summary
public static boolean getThreadPrefersEventExtractors() Should this thread prefer event based over usermodel based extractors? (usermodel extractors tend to be more accurate, but use more memory) Default is false. Returns:boolean true if event extractors should be preferred in the current thread, false otherwise.

getThreadPrefersEventExtractors

back to summary

public static boolean getThreadPrefersEventExtractors()

Should this thread prefer event based over usermodel based extractors? (usermodel extractors tend to be more accurate, but use more memory) Default is false.

Returns:boolean: true if event extractors should be preferred in the current thread, false otherwise.

removeProvider	back to summary
public static void removeProvider(Class<? extends ExtractorProvider> provider)

removeThreadPrefersEventExtractorsSetting back to summary

removeThreadPrefersEventExtractorsSetting	back to summary
public static void removeThreadPrefersEventExtractorsSetting() Clears the setting for this thread made by `setThreadPrefersEventExtractors(boolean)` Since POI 5.2.4 See Also `setThreadPrefersEventExtractors(boolean)`

public static void removeThreadPrefersEventExtractorsSetting()

Clears the setting for this thread made by setThreadPrefersEventExtractors(boolean)

Since: POI 5.2.4
See Also: setThreadPrefersEventExtractors(boolean)

setAllThreadsPreferEventExtractors	back to summary
public static void setAllThreadsPreferEventExtractors(Boolean preferEventExtractors) Should all threads prefer event based over usermodel based extractors? If set, will take preference over the Thread level setting. Parameters preferEventExtractors:Boolean If all threads should prefer event based extractors.

setAllThreadsPreferEventExtractors

back to summary

public static void setAllThreadsPreferEventExtractors(Boolean preferEventExtractors)

Should all threads prefer event based over usermodel based extractors? If set, will take preference over the Thread level setting.

Parameters

preferEventExtractors:Boolean: If all threads should prefer event based extractors.

setThreadPrefersEventExtractors back to summary

setThreadPrefersEventExtractors	back to summary
public static void setThreadPrefersEventExtractors(boolean preferEventExtractors) Should this thread prefer event based over usermodel based extractors? Will only be used if the All Threads setting is null. This uses ThreadLocals and these can leak resources when you have a lot of threads. You should always try to call `removeThreadPrefersEventExtractorsSetting()`. Parameters preferEventExtractors:boolean If this threads should prefer event based extractors.

public static void setThreadPrefersEventExtractors(boolean preferEventExtractors)

Should this thread prefer event based over usermodel based extractors? Will only be used if the All Threads setting is null.

This uses ThreadLocals and these can leak resources when you have a lot of threads.

You should always try to call removeThreadPrefersEventExtractorsSetting().

Parameters

preferEventExtractors:boolean: If this threads should prefer event based extractors.

wp	back to summary
private static POITextExtractor wp(FileMagic fm, ExtractorFactory.ProviderMethod fun) throws IOException

public final Class ExtractorFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface ExtractorFactory.ProviderMethod

Method Summary

Method Detail

private Class ExtractorFactory.Singleton

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail