Interface Parser
- All Known Implementing Classes:
AbiWordParser
,AbstractParser
,CatchAllParser
,DOCParser
,DummyParser
,EpubParser
,HTMLParser
,KOfficeParser
,OpenOfficeParser
,PDFParser
,PPTParser
,RarParser
,RTFParser
,SevenZipParser
,TarParser
,TXTParser
,XLSParser
,XMLParser
,ZABWParser
,ZipParser
- Author:
- Michael Scholz
-
Method Summary
Modifier and TypeMethodDescriptionint
countPages
(File file, String filename) Same as the othercountPages(InputStream, String)
, but use this when you have a file rather than a stream.int
countPages
(InputStream input, String filename) Counts the number of pages of the given binary document.Same asparse(InputStream, String, String, Locale, String)
, use this when you have a file rather than a stream.parse
(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) Same asparse(InputStream, ParseParameters)
, but use this when you have a file rather than a stream.parse
(InputStream input, ParseParameters parameterObject) Extracts content for the text content of the given binary document.Extracts content for the text content of the given binary document.
-
Method Details
-
parse
String parse(File file, String filename, String encoding, Locale locale, String tenant) throws ParseException Same asparse(InputStream, String, String, Locale, String)
, use this when you have a file rather than a stream.- Parameters:
file
- the filefilename
- name of the fileencoding
- character encodinglocale
- the localetenant
- name of the tenant- Returns:
- the extracted text
- Throws:
ParseException
- error in the parsing
-
parse
String parse(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) throws ParseException Same asparse(InputStream, ParseParameters)
, but use this when you have a file rather than a stream.- Parameters:
file
- the filefilename
- name of the fileencoding
- character encodinglocale
- the localetenant
- name of the tenantdocument
- the document the file belongs to (optional)fileVersion
- the file version being processed (optional)- Returns:
- the extracted text
- Throws:
ParseException
- error in the parsing
-
parse
Extracts content for the text content of the given binary document. The content type and character encoding (if available and applicable) are given as arguments.The implementation can choose either to read and parse the given document immediately or to return a reader that does it incrementally. The only constraint is that the implementation must close the given stream latest when the returned reader is closed. The caller on the other hand is responsible for closing the returned reader.
The implementation should only throw an exception on transient errors, i.e. when it can expect to be able to successfully extract the text content of the same binary at another time. An effort should be made to recover from syntax errors and other similar problems.
This method should be thread-safe, i.e. it is possible that this method is invoked simultaneously by different threads to extract the text content of different documents. On the other hand the returned reader does not need to be thread-safe.
The parsing has to be completed before the seconds specified in the parser.timeout config. property.
- Parameters:
input
- binary content from which to extract the textparameterObject
- the parameters- Returns:
- the extracted text
- Throws:
ParseException
- error in the parsing
-
parse
String parse(InputStream input, String filename, String encoding, Locale locale, String tenant) throws ParseException Extracts content for the text content of the given binary document. The content type and character encoding (if available and applicable) are given as arguments.The implementation can choose either to read and parse the given document immediately or to return a reader that does it incrementally. The only constraint is that the implementation must close the given stream latest when the returned reader is closed. The caller on the other hand is responsible for closing the returned reader.
The implementation should only throw an exception on transient errors, i.e. when it can expect to be able to successfully extract the text content of the same binary at another time. An effort should be made to recover from syntax errors and other similar problems.
This method should be thread-safe, i.e. it is possible that this method is invoked simultaneously by different threads to extract the text content of different documents. On the other hand the returned reader does not need to be thread-safe.
The parsing has to be completed before the seconds specified in the parser.timeout config. property.
- Parameters:
input
- binary content from which to extract the textfilename
- name of the fileencoding
- character encodinglocale
- the localetenant
- name of the tenant- Returns:
- the extracted text
- Throws:
ParseException
- error in the parsing
-
countPages
Counts the number of pages of the given binary document.- Parameters:
input
- binary content from which to extract the textfilename
- name of the file- Returns:
- the number of pages
-
countPages
Same as the othercountPages(InputStream, String)
, but use this when you have a file rather than a stream.- Parameters:
file
- the filefilename
- name of the file- Returns:
- the number of pages
-