Package com.norconex.importer.parser.impl

Class AbstractTikaParser

java.lang.Object

com.norconex.importer.parser.impl.AbstractTikaParser

All Implemented Interfaces:

IDocumentParser, IHintsAwareParser

Direct Known Subclasses:

FallbackParser

public class AbstractTikaParser
extends Object
implements IHintsAwareParser

Base class wrapping Apache Tika parser for use by the importer.

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractTikaParser.MergeEmbeddedParser
protected static interface	AbstractTikaParser.RecursiveParser
protected class	AbstractTikaParser.SplitEmbbededParser

Constructor Summary

Constructors

Constructor	Description
AbstractTikaParser(org.apache.tika.parser.Parser parser)	Creates a new Tika-based parser.

Method Summary

Modifier and Type	Method	Description
protected void	addTikaMetadataToImporterMetadata(org.apache.tika.metadata.Metadata tikaMeta, Properties metadata)
protected AbstractTikaParser.RecursiveParser	createRecursiveParser(String reference, String contentType, Writer writer, Properties metadata, CachedStreamFactory streamFactory)
boolean	equals(Object other)
OCRConfig	getOCRConfig()	Deprecated. Use initialize(ParseHints)
int	hashCode()
void	initialize(ParseHints parserHints)	Initialize this parser with the given parse hints.
boolean	isSplitEmbedded()	Deprecated. Use initialize(ParseHints)
protected void	modifyParseContext(org.apache.tika.parser.ParseContext parseContext)	Override to apply your own settings on the Tika ParseContext.
List<Doc>	parseDocument(Doc doc, Writer output)	Parses a document.
void	setOCRConfig(OCRConfig ocrConfig)	Deprecated. Use initialize(ParseHints)
void	setSplitEmbedded(boolean splitEmbedded)	Deprecated. Use initialize(ParseHints)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractTikaParser

public AbstractTikaParser(org.apache.tika.parser.Parser parser)

Creates a new Tika-based parser.

Parameters:

parser - Tika parser

Method Detail

initialize

public void initialize(ParseHints parserHints)

Description copied from interface: IHintsAwareParser

Initialize this parser with the given parse hints. While not mandatory, aware parsers are strongly encouraged to support applicable hints.

Specified by:

initialize in interface IHintsAwareParser

Parameters:

parserHints - configuration settings influencing parsing when possible or appropriate

parseDocument

public final List<Doc> parseDocument(Doc doc,
                                     Writer output)
                              throws DocumentParserException

Description copied from interface: IDocumentParser

Parses a document.

Specified by:

parseDocument in interface IDocumentParser

Parameters:

doc - importer document to parse

output - where to store extracted or modified content of the supplied document

Returns:

a list of first-level embedded documents, if any

Throws:

DocumentParserException - problem parsing document

modifyParseContext

protected void modifyParseContext(org.apache.tika.parser.ParseContext parseContext)

Override to apply your own settings on the Tika ParseContext. The ParseContext is already configured before calling this method. Changing existing settings may cause failure. Only override if you know what you are doing. The default implementation does nothing.

Parameters:

parseContext - Tika parse context

addTikaMetadataToImporterMetadata

protected void addTikaMetadataToImporterMetadata(org.apache.tika.metadata.Metadata tikaMeta,
                                                 Properties metadata)

createRecursiveParser

protected AbstractTikaParser.RecursiveParser createRecursiveParser(String reference,
                                                                   String contentType,
                                                                   Writer writer,
                                                                   Properties metadata,
                                                                   CachedStreamFactory streamFactory)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setOCRConfig

@Deprecated
public void setOCRConfig(OCRConfig ocrConfig)

Deprecated.

Use initialize(ParseHints)

Sets the OCR configuration.

Parameters:

ocrConfig - the ocrConfig to set

Since:

2.1.0

getOCRConfig

@Deprecated
public OCRConfig getOCRConfig()

Deprecated.

Use initialize(ParseHints)

Gets the OCR configuration (never null).

Returns:

the OCR configuration

Since:

2.1.0

isSplitEmbedded

@Deprecated
public boolean isSplitEmbedded()

Deprecated.

Use initialize(ParseHints)

Gets whether embedded documents should be split to become "standalone" distinct documents.

Returns:

true if parser should split embedded documents.

setSplitEmbedded

@Deprecated
public void setSplitEmbedded(boolean splitEmbedded)

Deprecated.

Use initialize(ParseHints)

Sets whether embedded documents should be split to become "standalone" distinct documents.

Parameters:

splitEmbedded - true if parser should split embedded documents.