This page provides a number of examples on how to use the various Tika APIs. All of the examples shown are also available in the Tika Example module in SVN.
- Apache Tika API Usage Examples
- Picking different output formats
- Custom Content Handlers
- Language Identification
Tika provides a number of different ways to parse a file. These provide different levels of control, flexibility, and complexity.
The Tika facade, provides a number of very quick and easy ways to have your content parsed by Tika, and return the resulting plain text
For more control, you can call the Tika Parsers directly. Most likely, you'll want to start out using the Auto-Detect Parser, which automatically figures out what kind of content you have, then calls the appropriate parser for you.
With Tika, you can get the textual content of your files returned in a number of different formats. These can be plain text, html, xhtml, xhtml of one part of the file etc. This is controlled based on the ContentHandler you supply to the Parser.
By using the BodyContentHandler, you can request that Tika return only the content of the document's body as a plain-text string.
By using the ToXMLContentHandler, you can get the XHTML content of the whole document as a string.
It possible to execute XPath queries on the parse results, to fetch only certain bits of the XHTML.
The textual output of parsing a file with Tika is returned via the SAX ContentHandler you pass to the parse method. It is possible to customise your parsing by supplying your own ContentHandler which does special things.
By using the PhoneExtractingContentHandler, you can have any phone numbers found in the textual content of the document extracted and placed into the Metadata object for you.
Sometimes, you want to chunk the resulting text up, perhaps to output as you go minimising memory use, perhaps to output to HDFS files, or any other reason! With a small custom content handler, you can do that.
Tika provides a pluggable Translation system, which allow you to send the results of parsing off to an external system or program to have the text translated into another language.
In order to use the Microsoft Translation API, you need to sign up for a Microsoft account, get an API key, then pass the key to Tika before translating.