org.jahia.services.textextraction

Class TextExtractionService

java.lang.Object

org.jahia.services.textextraction.TextExtractionService

public class TextExtractionService
extends Object

Jahia metadata and text extraction service that uses Apache Tika for parsing documents.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
TextExtractionService()

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(InputStream stream, org.apache.tika.metadata.Metadata metadata) Performs a check if the provided content can be handled by currently configured parsers.
void	extractMetadata(InputStream stream, org.apache.tika.metadata.Metadata metadata) Performs the metadata extraction for the specified document stream.
boolean	isEnabled() Returns true if the text extraction service is activated.
String	parse(InputStream stream, org.apache.tika.metadata.Metadata metadata) Performs the content extraction and fills in related metadata for the specified document stream.
String	parse(InputStream stream, org.apache.tika.metadata.Metadata metadata, int characterLimit) Performs the content extraction and fills in related metadata for the specified document stream.
String	parse(InputStream stream, String contentType) Performs the content extraction for the specified document stream.
void	setAutoDetectType(boolean autoDetectType)
void	setConfig(org.springframework.core.io.Resource config) Provides the Tika configuration resource.
void	setConfigMetadata(org.springframework.core.io.Resource configMetadata)
void	setEnabled(boolean enabled) Set this flag to true to enable the text extraction service.
void	setMaxExtractedCharacters(int maxExtractedCharacters)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextExtractionService

public TextExtractionService()

Method Detail

canHandle

public boolean canHandle(InputStream stream,
                         org.apache.tika.metadata.Metadata metadata)
                  throws IOException

Performs a check if the provided content can be handled by currently configured parsers.
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Parameters:

stream - the document stream to be parsed; can be null, in this case the contentType only will be used to detect appropriate parser

metadata - the metadata containing parser specific information, like content type, encoding etc.

Returns:

true if there is a parser that can handle provided content

Throws:

IOException - in case of the read/write errors

extractMetadata

public void extractMetadata(InputStream stream,
                            org.apache.tika.metadata.Metadata metadata)
                     throws IOException,
                            SAXException,
                            org.apache.tika.exception.TikaException

Performs the metadata extraction for the specified document stream.
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Parameters:

stream - the document stream to be parsed

metadata - the metadata containing parser specific information, like content type, encoding etc.

Throws:

IOException - in case of the read/write errors

SAXException - in case of parsing errors

org.apache.tika.exception.TikaException - in case of parsing errors

isEnabled

public boolean isEnabled()

Returns true if the text extraction service is activated.

Returns:

true if the text extraction service is activated

parse

public String parse(InputStream stream,
                    org.apache.tika.metadata.Metadata metadata)
             throws IOException,
                    SAXException,
                    org.apache.tika.exception.TikaException

Performs the content extraction and fills in related metadata for the specified document stream.
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Parameters:

stream - the document stream to be parsed

metadata - the metadata containing parser specific information, like content type, encoding etc.

Returns:

the text representation of the extracted content or null if the service is disabled

Throws:

IOException - in case of the read/write errors

SAXException - in case of parsing errors

org.apache.tika.exception.TikaException - in case of parsing errors

parse

public String parse(InputStream stream,
                    org.apache.tika.metadata.Metadata metadata,
                    int characterLimit)
             throws IOException,
                    SAXException,
                    org.apache.tika.exception.TikaException

Performs the content extraction and fills in related metadata for the specified document stream.
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Parameters:

stream - the document stream to be parsed

metadata - the metadata containing parser specific information, like content type, encoding etc.

characterLimit - the maximum number of characters to extract or -1 to extract full document content

Returns:

the text representation of the extracted content or null if the service is disabled

Throws:

IOException - in case of the read/write errors

SAXException - in case of parsing errors

org.apache.tika.exception.TikaException - in case of parsing errors

parse

public String parse(InputStream stream,
                    String contentType)
             throws IOException,
                    SAXException,
                    org.apache.tika.exception.TikaException

Performs the content extraction for the specified document stream.
The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Parameters:

stream - the document stream to be parsed

contentType - the content type of the provided document

Returns:

the text representation of the extracted content or null if the service is disabled

Throws:

IOException - in case of the read/write errors

SAXException - in case of parsing errors

org.apache.tika.exception.TikaException - in case of parsing errors

setAutoDetectType

public void setAutoDetectType(boolean autoDetectType)

Parameters:

autoDetectType - the autoDetectType to set

setConfig

public void setConfig(org.springframework.core.io.Resource config)

Provides the Tika configuration resource.

Parameters:

config - the Tika configuration resource

setConfigMetadata

public void setConfigMetadata(org.springframework.core.io.Resource configMetadata)

Parameters:

configMetadata - the configMetadata to set

setEnabled

public void setEnabled(boolean enabled)

Set this flag to true to enable the text extraction service.

Parameters:

enabled - the flag to set

setMaxExtractedCharacters

public void setMaxExtractedCharacters(int maxExtractedCharacters)

Parameters:

maxExtractedCharacters - the maxExtractedCharacters to set