Package org.apache.tika.parser.ner

Class NamedEntityParser

java.lang.Object

org.apache.tika.parser.ner.NamedEntityParser

All Implemented Interfaces:

Serializable, Parser

public class NamedEntityParser
extends Object
implements Parser

This implementation of Parser extracts entity names from text content and adds it to the metadata.

All the metadata keys will have a common suffix "NER_"

The Named Entity recogniser implementation can be changed by setting the system property "ner.impl.class" value to a name of class that implements NERecogniser contract

See Also:

• OpenNLPNERecogniser
• NERecogniser
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NER_IMPL
static final org.slf4j.Logger	LOG
static final String	MD_KEY_PREFIX
static final Set<MediaType>	MEDIA_TYPES
Tika	secondaryParser
static final String	SYS_PROP_NER_IMPL

Constructor Summary

Constructors

Constructor	Description
NamedEntityParser()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext parseContext)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(InputStream inputStream, ContentHandler contentHandler, Metadata metadata, ParseContext parseContext)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static final org.slf4j.Logger LOG

MEDIA_TYPES

public static final Set<MediaType> MEDIA_TYPES

MD_KEY_PREFIX

public static final String MD_KEY_PREFIX

See Also:

• Constant Field Values

DEFAULT_NER_IMPL

public static final String DEFAULT_NER_IMPL

SYS_PROP_NER_IMPL

public static final String SYS_PROP_NER_IMPL

See Also:

• Constant Field Values

secondaryParser

public Tika secondaryParser

Constructor Details

NamedEntityParser

public NamedEntityParser()

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext parseContext)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

parseContext - parse context

Returns:

immutable set of media types

parse

public void parse(InputStream inputStream,
 ContentHandler contentHandler,
 Metadata metadata,
 ParseContext parseContext)
           throws IOException,
SAXException,
TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

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

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Parameters:

inputStream - the document stream (input)

contentHandler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

parseContext - parse context

Throws:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed