eus.ixa.ixa.pipe.nerc

Class DictionariesNameFinder

java.lang.Object

eus.ixa.ixa.pipe.nerc.DictionariesNameFinder

All Implemented Interfaces:

NameFinder

public class DictionariesNameFinder
extends Object
implements NameFinder

Named Entity Recognition module based on Dictionaries objects This class provides the following functionalities:

1. string matching against of a string (typically tokens) against a Dictionary containing names. This function is also used to implement Dictionary based features in the training package.
2. tag: Provided a Dictionaries it tags only the names it matches against it
3. post: This function checks for names in the Dictionary that have not been detected by a StatisticalNameFinder; it also corrects the Name type for those detected by a StatisticalNameFinder but also present in a dictionary.

Author:

ragerri 2014/03/14

Constructor Summary

Constructors

Constructor and Description
DictionariesNameFinder(Dictionaries aDictionaries) Construct a DictionaryNameFinder using one dictionary and one named entity class.
DictionariesNameFinder(Dictionaries aDictionaries, NameFactory aNameFactory) Construct a DictionariesNameFinder with a dictionary, a type and a name factory.

Method Summary

Modifier and Type	Method and Description
void	clearAdaptiveData() Clear the adaptiveData for each document.
List<Name>	getNames(String[] tokens) Dictionaries based Named Entity Detection and Classification.
List<Name>	getNamesFromSpans(opennlp.tools.util.Span[] neSpans, String[] tokens) Creates a list of Name objects from spans and tokens.
opennlp.tools.util.Span[]	nercToSpans(String[] tokens) Detects Named Entities in a Dictionaries by NE type ignoring case.
opennlp.tools.util.Span[]	nercToSpansExact(String[] tokens) Detects Named Entities in a Dictionaries by NE type This method is case sensitive.

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionariesNameFinder

public DictionariesNameFinder(Dictionaries aDictionaries)

Construct a DictionaryNameFinder using one dictionary and one named entity class.

Parameters:

aDictionaries - the dictionaries

DictionariesNameFinder

public DictionariesNameFinder(Dictionaries aDictionaries,
                              NameFactory aNameFactory)

Construct a DictionariesNameFinder with a dictionary, a type and a name factory.

Parameters:

aDictionaries - the dictionaries

aNameFactory - the factory

Method Detail

getNames

public final List<Name> getNames(String[] tokens)

Dictionaries based Named Entity Detection and Classification.

Specified by:

getNames in interface NameFinder

Parameters:

tokens - the tokenized sentence

Returns:

a list of detected Name objects

nercToSpans

public final opennlp.tools.util.Span[] nercToSpans(String[] tokens)

Detects Named Entities in a Dictionaries by NE type ignoring case.

Specified by:

nercToSpans in interface NameFinder

Parameters:

tokens - the tokenized sentence

Returns:

spans of the Named Entities

nercToSpansExact

public final opennlp.tools.util.Span[] nercToSpansExact(String[] tokens)

Detects Named Entities in a Dictionaries by NE type This method is case sensitive.

Parameters:

tokens - the tokenized sentence

Returns:

spans of the Named Entities all

getNamesFromSpans

public final List<Name> getNamesFromSpans(opennlp.tools.util.Span[] neSpans,
                                          String[] tokens)

Creates a list of Name objects from spans and tokens.

Specified by:

getNamesFromSpans in interface NameFinder

Parameters:

neSpans - the spans of the entities in the sentence

tokens - the tokenized sentence

Returns:

a list of Name objects

clearAdaptiveData

public void clearAdaptiveData()

Clear the adaptiveData for each document.

Specified by:

clearAdaptiveData in interface NameFinder