de.datexis.ner

Class MatchingAnnotator

java.lang.Object

de.datexis.annotator.Annotator

de.datexis.ner.MatchingAnnotator

public class MatchingAnnotator
extends Annotator

An Annotator that creates MentionAnnotations based on a term list for String matching.

Author:

Sebastian Arnold

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchingAnnotator.MatchingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
protected MatchingAnnotator.MatchingStrategy	matchingStrategy
protected int	minimumWordLength
protected Annotation.Source	source
protected net.amygdalum.stringsearchalgorithms.search.chars.StringSearchAlgorithm	stringSearch
protected String	type
protected Pattern	uppercaseMatcher
protected WordHelpers	wordHelpers
protected Pattern	wordLengthMatcher

Fields inherited from class de.datexis.annotator.Annotator

components, it, provenance, tagger

Constructor Summary

Constructors

Constructor and Description
MatchingAnnotator()
MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchingStrategy)
MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase, Annotation.Source source)
MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase, Annotation.Source source, String type)
MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase, Annotation.Source source, String type, int minWordLength)

Method Summary

Modifier and Type	Method and Description
void	annotate(Collection<Document> docs)
void	annotate(Iterable<Document> docs, Annotation.Source source) Annotates a Dataset using the pre-trained list.
void	clearTermsToMatch()
protected Collection<String>	convertTerms(Stream<String> terms)
protected String	convertToLowercase(String text)
int	countTerms()
void	deleteTermsToMatch(Collection<String> terms)
void	deleteTermsToMatch(Resource path)
void	deleteTermsToMatch(Stream<String> terms)
void	loadTermsToMatch(Collection<String> terms)
void	loadTermsToMatch(Resource path)
void	loadTermsToMatch(Stream<String> terms)
protected String	removePlurals(String text)

Methods inherited from class de.datexis.annotator.Annotator

addComponent, annotate, annotate, annotate, createDataset, createDocument, getComponent, getProvenance, getTagger, isModelAvailable, isModelAvailableInChildren, readModel, trainModel, writeComponents, writeHTML, writeModel, writeModel, writeTestLog, writeTrainLog

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

minimumWordLength

protected int minimumWordLength

type

protected String type

wordLengthMatcher

protected Pattern wordLengthMatcher

uppercaseMatcher

protected Pattern uppercaseMatcher

stringSearch

protected net.amygdalum.stringsearchalgorithms.search.chars.StringSearchAlgorithm stringSearch

wordHelpers

protected WordHelpers wordHelpers

matchingStrategy

protected MatchingAnnotator.MatchingStrategy matchingStrategy

source

protected Annotation.Source source

Constructor Detail

MatchingAnnotator

public MatchingAnnotator()

MatchingAnnotator

public MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchingStrategy)

MatchingAnnotator

public MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase,
                         Annotation.Source source)

MatchingAnnotator

public MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase,
                         Annotation.Source source,
                         String type)

MatchingAnnotator

public MatchingAnnotator(MatchingAnnotator.MatchingStrategy matchLowercase,
                         Annotation.Source source,
                         String type,
                         int minWordLength)

Method Detail

convertTerms

protected Collection<String> convertTerms(Stream<String> terms)

clearTermsToMatch

public void clearTermsToMatch()

loadTermsToMatch

public void loadTermsToMatch(Collection<String> terms)

loadTermsToMatch

public void loadTermsToMatch(Stream<String> terms)

loadTermsToMatch

public void loadTermsToMatch(Resource path)
                      throws IOException

Throws:

IOException

deleteTermsToMatch

public void deleteTermsToMatch(Collection<String> terms)

deleteTermsToMatch

public void deleteTermsToMatch(Stream<String> terms)

deleteTermsToMatch

public void deleteTermsToMatch(Resource path)
                        throws IOException

Throws:

IOException

countTerms

public int countTerms()

convertToLowercase

protected String convertToLowercase(String text)

Returns:

text with all words >3 chars converted to lowercase.

removePlurals

protected String removePlurals(String text)

annotate

public void annotate(Collection<Document> docs)

Overrides:

annotate in class Annotator

annotate

public void annotate(Iterable<Document> docs,
                     Annotation.Source source)

Annotates a Dataset using the pre-trained list.

Parameters:

docs - - the Documents to annotate

source - - the type of annotations to create, e.g. SILVER