gov.sandia.cognition.text.term.filter

Class DictionaryFilter

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.text.term.filter.AbstractSingleTermFilter

gov.sandia.cognition.text.term.filter.DictionaryFilter

All Implemented Interfaces:

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

public class DictionaryFilter
extends AbstractSingleTermFilter

A term filter that only allows terms in its dictionary.

Since:

3.0

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<Term>	allowedTerms The set of terms allowed by the filter.

Constructor Summary

Constructors

Constructor and Description
DictionaryFilter() Creates a new DictionaryFilter with an empty set of allowed terms.
DictionaryFilter(java.util.Set<Term> allowedTerms) Creates a new DictionaryFilter with a given set of allowed terms.

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.
java.util.Set<Term>	getAllowedTerms() Gets the set of allowed terms.
void	setAllowedTerms(java.util.Set<Term> allowedTerms) Sets the set of allowed terms.

Methods inherited from class gov.sandia.cognition.text.term.filter.AbstractSingleTermFilter

filterTerms

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

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

clone

Field Detail

allowedTerms

protected java.util.Set<Term> allowedTerms

The set of terms allowed by the filter. All other terms are discarded.

Constructor Detail

DictionaryFilter

public DictionaryFilter()

Creates a new DictionaryFilter with an empty set of allowed terms.

DictionaryFilter

public DictionaryFilter(java.util.Set<Term> allowedTerms)

Creates a new DictionaryFilter with a given set of allowed terms.

Parameters:

allowedTerms - The set of allowed terms.

Method Detail

filterTerm

public TermOccurrence filterTerm(TermOccurrence occurrence)

Description copied from interface: SingleTermFilter

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.

getAllowedTerms

public java.util.Set<Term> getAllowedTerms()

Gets the set of allowed terms.

Returns:

The set of allowed terms.

setAllowedTerms

public void setAllowedTerms(java.util.Set<Term> allowedTerms)

Sets the set of allowed terms.

Parameters:

allowedTerms - The set of allowed terms.