org.apache.tika.parser.ner

Interface NERecogniser

All Known Implementing Classes:

CoreNLPNERecogniser, OpenNLPNameFinder, OpenNLPNERecogniser, RegexNERecogniser

public interface NERecogniser

Defines a contract for named entity recogniser. The NER contract includes isAvailable(), getEntityTypes() and recognise( String )

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE
static String	LOCATION
static String	MISCELLANEOUS
static String	MONEY
static String	ORGANIZATION
static String	PERCENT
static String	PERSON
static String	TIME

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getEntityTypes() gets a set of entity types whose names are recognisable by this
boolean	isAvailable() checks if this Named Entity recogniser is available for service
Map<String,Set<String>>	recognise(String text) call for name recognition action from text

Field Detail

LOCATION

static final String LOCATION

See Also:

Constant Field Values

PERSON

static final String PERSON

See Also:

Constant Field Values

ORGANIZATION

static final String ORGANIZATION

See Also:

Constant Field Values

MISCELLANEOUS

static final String MISCELLANEOUS

See Also:

Constant Field Values

TIME

static final String TIME

See Also:

Constant Field Values

DATE

static final String DATE

See Also:

Constant Field Values

PERCENT

static final String PERCENT

See Also:

Constant Field Values

MONEY

static final String MONEY

See Also:

Constant Field Values

Method Detail

isAvailable

boolean isAvailable()

checks if this Named Entity recogniser is available for service

Returns:

true if this recogniser is ready to recognise, false otherwise

getEntityTypes

Set<String> getEntityTypes()

gets a set of entity types whose names are recognisable by this

Returns:

set of entity types/classes

recognise

Map<String,Set<String>> recognise(String text)

call for name recognition action from text

Parameters:

text - text with possibly contains names

Returns:

map of entityType -> set of names