io.redlink.nlp.regex.ner.vocab

Class VocabularyDetector

java.lang.Object

io.redlink.nlp.regex.ner.RegexNamedEntityFactory

io.redlink.nlp.regex.ner.vocab.VocabularyDetector

Direct Known Subclasses:

CsvVocabularyNerDetector

public abstract class VocabularyDetector
extends RegexNamedEntityFactory

Regex-Based detection of trains

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VocabularyDetector.CaseSensitivity

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
VocabularyDetector(String name, NerTag type, Locale lang, VocabularyDetector.CaseSensitivity caseSensitivity)

Method Summary

Modifier and Type	Method and Description
protected RegexNerProcessor.NamedEntity	createNamedEntity(String patternName, MatchResult match) Creates a token for the parsed MatchResult originating from the RegexNamedEntityFactory.NamedPattern with the parsed name
VocabularyDetector.CaseSensitivity	getCaseSensitivity()
Locale	getLanguage()
String	getName()
protected List<RegexNamedEntityFactory.NamedPattern>	getRegexes(SpanCollection section, String lang) Getter for the RegexNamedEntityFactory.NamedPattern to be used by the RegexNerProcessor
protected void	init()
protected abstract Collection<VocabularyEntry>	loadEntries()
protected String	normalize(String label) Normalizes labels by StringUtils.trimToNull(String) and if #isCaseSensitive() converts the label to lower case using getLanguage() specific rules

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

VocabularyDetector

public VocabularyDetector(String name,
                          NerTag type,
                          Locale lang,
                          VocabularyDetector.CaseSensitivity caseSensitivity)

Method Detail

getName

public final String getName()

normalize

protected String normalize(String label)

Normalizes labels by StringUtils.trimToNull(String) and if #isCaseSensitive() converts the label to lower case using getLanguage() specific rules

Parameters:

label - the label to normalize

Returns:

the normalized label - null if the label is invalid

getCaseSensitivity

public VocabularyDetector.CaseSensitivity getCaseSensitivity()

getLanguage

public Locale getLanguage()

init

@PostConstruct
protected final void init()
                                  throws IOException

Throws:

IOException

loadEntries

protected abstract Collection<VocabularyEntry> loadEntries()
                                                    throws IOException

Throws:

IOException

createNamedEntity

protected 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.

getRegexes

protected 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