gov.sandia.cognition.text.term.filter

Interface SingleTermFilter

All Superinterfaces:

java.lang.Cloneable, CloneableSerializable, java.io.Serializable, TermFilter

All Known Implementing Classes:

AbstractSingleTermFilter, DictionaryFilter, LowerCaseTermFilter, PorterEnglishStemmingFilter, StopListFilter, StringEvaluatorSingleTermFilter, SynonymFilter, TermLengthFilter

public interface SingleTermFilter
extends TermFilter

Interface for a term filter that looks at each term individually.

Since:

3.0

Author:

Justin Basilico

Method Summary

Modifier and Type	Method and Description
TermOccurrence	filterTerm(TermOccurrence occurrence) Takes a single term occurrence and filters that occurrence into a new occurrence or returns null, indicating that the filter rejects that term.

Methods inherited from interface gov.sandia.cognition.text.term.filter.TermFilter

filterTerms

Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable

clone

Method Detail

filterTerm

TermOccurrence filterTerm(TermOccurrence occurrence)

Takes a single term occurrence and filters that occurrence into a new occurrence or returns null, indicating that the filter rejects that term.

Parameters:

occurrence - The term occurrence to filter.

Returns:

A term occurrence (may be a new instance or the same as the given one) of the term to replace the given one or null to indicate that the filter has rejected the given term.