org.apache.tika.parser.ner.nltk

Class NLTKNERecogniser

java.lang.Object

org.apache.tika.parser.ner.nltk.NLTKNERecogniser

All Implemented Interfaces:

NERecogniser

public class NLTKNERecogniser
extends java.lang.Object
implements NERecogniser

This class offers an implementation of NERecogniser based on ne_chunk() module of NLTK. This NER requires additional setup, due to Http requests to an endpoint server that runs NLTK. See

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<java.lang.String>	ENTITY_TYPES some common entities identified by NLTK

Fields inherited from interface org.apache.tika.parser.ner.NERecogniser

DATE, LOCATION, MISCELLANEOUS, MONEY, ORGANIZATION, PERCENT, PERSON, TIME

Constructor Summary

Constructors

Constructor and Description
NLTKNERecogniser()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getEntityTypes() Gets set of entity types recognised by this recogniser
boolean	isAvailable() checks if this Named Entity recogniser is available for service
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	recognise(java.lang.String text) recognises names of entities in the text

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPES

public static final java.util.Set<java.lang.String> ENTITY_TYPES

some common entities identified by NLTK

Constructor Detail

NLTKNERecogniser

public NLTKNERecogniser()

Method Detail

isAvailable

public boolean isAvailable()

Description copied from interface: NERecogniser

checks if this Named Entity recogniser is available for service

Specified by:

isAvailable in interface NERecogniser

Returns:

true if server endpoint is available. returns false if server endpoint is not avaliable for service.

getEntityTypes

public java.util.Set<java.lang.String> getEntityTypes()

Gets set of entity types recognised by this recogniser

Specified by:

getEntityTypes in interface NERecogniser

Returns:

set of entity classes/types

recognise

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> recognise(java.lang.String text)

recognises names of entities in the text

Specified by:

recognise in interface NERecogniser

Parameters:

text - text which possibly contains names

Returns:

map of entity type -> set of names