io.redlink.nlp.regex.ner

Class RegexNerDetector

java.lang.Object

io.redlink.nlp.regex.ner.RegexNamedEntityFactory

io.redlink.nlp.regex.ner.RegexNerDetector

Direct Known Subclasses:

LinebasedRegexListNerDetector, WordListDetector

public abstract class RegexNerDetector
extends RegexNamedEntityFactory

Simplifies the Implementation of a RegexNamedEntityFactory in cases where

1. all created NamedEntities do use a single NerTag
2. the created NamedEntities do use MatchResult.group() as Token#getValue()

Subclasses just need to implement the initPatterns() Method that is called once and is expected to provide the list of Regex patterns. The acceptMatch(String) provides an callback so that unwanted matches can be filtered out. The default implementation will filter all blank matches

Author:

Rupert Westenthaler

Nested Class Summary

Nested classes/interfaces inherited from class io.redlink.nlp.regex.ner.RegexNamedEntityFactory

RegexNamedEntityFactory.NamedPattern

Field Summary

Fields inherited from class io.redlink.nlp.regex.ner.RegexNamedEntityFactory

log

Constructor Summary

Constructors

Constructor and Description
RegexNerDetector(String name, NerTag type)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptMatch(String value) Can be overwritten to validate matches based on the Token#getValue().
protected RegexNerProcessor.NamedEntity	createNamedEntity(String patternName, MatchResult match) Creates a token for the parsed MatchResult originating from the RegexNamedEntityFactory.NamedPattern with the parsed name
String	getName()
protected List<RegexNamedEntityFactory.NamedPattern>	getRegexes(SpanCollection section, String lang) Getter for the RegexNamedEntityFactory.NamedPattern to be used by the RegexNerProcessor
NerTag	getType()
protected void	init()
protected abstract Map<String,List<Pattern>>	initPatterns()

Methods inherited from class io.redlink.nlp.regex.ner.RegexNamedEntityFactory

process

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexNerDetector

public RegexNerDetector(String name,
                        NerTag type)

Method Detail

getName

public String getName()

getType

public NerTag getType()

init

@PostConstruct
protected final void init()
                                  throws IOException

Throws:

IOException

initPatterns

protected abstract Map<String,List<Pattern>> initPatterns()
                                                   throws IOException

Throws:

IOException

getRegexes

protected final List<RegexNamedEntityFactory.NamedPattern> getRegexes(SpanCollection section,
                                                                      String lang)

Description copied from class: RegexNamedEntityFactory

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

Specified by:

getRegexes in class RegexNamedEntityFactory

Parameters:

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

lang - the language of the parsed text section

Returns:

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

createNamedEntity

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

Description copied from class: RegexNamedEntityFactory

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

Specified by:

createNamedEntity in class RegexNamedEntityFactory

Parameters:

patternName - the name of the RegexNamedEntityFactory.NamedPattern

match - the MatchResult

Returns:

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

acceptMatch

protected boolean acceptMatch(String value)

Can be overwritten to validate matches based on the Token#getValue(). The default implementation accepts all none black values

Parameters:

value - the value