io.redlink.nlp.regex.ner

Class RegexNamedEntityFactory

java.lang.Object

io.redlink.nlp.regex.ner.RegexNamedEntityFactory

Direct Known Subclasses:

NamedRegexDetector, RegexNerDetector, VocabularyDetector

public abstract class RegexNamedEntityFactory
extends Object

Extract patterns based on regexes. Subclasses need to provide a list of RegexNamedEntityFactory.NamedPattern. For matching RegexNamedEntityFactory.NamedPattern the createNamedEntity(String, MatchResult) is called with the name of the matching pattern and the matching result.

See Also:

RegexNerDetector, NamedRegexDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexNamedEntityFactory.NamedPattern A regex Pattern with an assigned Name.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
RegexNamedEntityFactory()

Method Summary

Modifier and Type	Method and Description
protected abstract RegexNerProcessor.NamedEntity	createNamedEntity(String patternName, MatchResult match) Creates a token for the parsed MatchResult originating from the RegexNamedEntityFactory.NamedPattern with the parsed name
protected abstract List<RegexNamedEntityFactory.NamedPattern>	getRegexes(SpanCollection section, String language) Getter for the RegexNamedEntityFactory.NamedPattern to be used by the RegexNerProcessor
void	process(SpanCollection section, String lang, List<RegexNerProcessor.NamedEntity> namedEntities)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

RegexNamedEntityFactory

public RegexNamedEntityFactory()

Method Detail

process

public final void process(SpanCollection section,
                          String lang,
                          List<RegexNerProcessor.NamedEntity> namedEntities)

createNamedEntity

protected abstract RegexNerProcessor.NamedEntity createNamedEntity(String patternName,
                                                                   MatchResult match)

Creates a token for the parsed MatchResult originating from the RegexNamedEntityFactory.NamedPattern with the parsed name

Parameters:

patternName - the name of the RegexNamedEntityFactory.NamedPattern

match - the MatchResult

Returns:

the RegexNerProcessor.NamedEntity or null if no Token was created.

getRegexes

protected abstract List<RegexNamedEntityFactory.NamedPattern> getRegexes(SpanCollection section,
                                                                         String language)

Getter for the RegexNamedEntityFactory.NamedPattern to be used by the RegexNerProcessor

Parameters:

section - the section of an AnalyzedText to be analyzed with the returned patterns

language - the language of the parsed text section

Returns:

the list of RegexNamedEntityFactory.NamedPattern or an empty list if none