gov.sandia.cognition.text.term.filter

Class TermLengthFilter

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

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

gov.sandia.cognition.text.term.filter.TermLengthFilter

All Implemented Interfaces:

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

public class TermLengthFilter
extends AbstractSingleTermFilter

Implements a filter based on the length of a term. The length is computed from the name of the term.

Since:

3.0

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_LENGTH The default maximum length is 28.
static int	DEFAULT_MINIMUM_LENGTH The default minimum length is 3.
protected java.lang.Integer	maximumLength The maximum allowed length.
protected java.lang.Integer	minimumLength The minimum allowed length.

Constructor Summary

Constructors

Constructor and Description
TermLengthFilter() Creates a new TermLengthFilter with default minimum and maximum values.
TermLengthFilter(java.lang.Integer minimumLength, java.lang.Integer maximumLength) Creates a new TermLengthFilter with given minimum and maximum values.

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.lang.Integer	getMaximumLength() Gets the maximum length allowed for a term (inclusive).
java.lang.Integer	getMinimumLength() Gets the minimum length allowed for a term (inclusive).
void	setMaximumLength(java.lang.Integer maximumLength) Gets the maximum length allowed for a term (inclusive).
void	setMinimumLength(java.lang.Integer minimumLength) Gets the minimum length allowed for a term (inclusive).

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

DEFAULT_MINIMUM_LENGTH

public static final int DEFAULT_MINIMUM_LENGTH

The default minimum length is 3.

See Also:

Constant Field Values

DEFAULT_MAXIMUM_LENGTH

@PublicationReference(author="Wikipedia",
                      title="Longest word in English",
                      year=2009,
                      type=WebPage,
                      url="http://en.wikipedia.org/wiki/Longest_word_in_English")
public static final int DEFAULT_MAXIMUM_LENGTH

The default maximum length is 28. Based on the maximum known length of non-technical and non-coined English words.

See Also:

Constant Field Values

minimumLength

protected java.lang.Integer minimumLength

The minimum allowed length. Inclusive. A null value indicates no minimum. Must be non-negative.

maximumLength

protected java.lang.Integer maximumLength

The maximum allowed length. Inclusive. A null value indicates no maximum. Must be non-negative.

Constructor Detail

TermLengthFilter

public TermLengthFilter()

Creates a new TermLengthFilter with default minimum and maximum values.

TermLengthFilter

public TermLengthFilter(java.lang.Integer minimumLength,
                        java.lang.Integer maximumLength)

Creates a new TermLengthFilter with given minimum and maximum values.

Parameters:

minimumLength - The minimum allowed term length.

maximumLength - The maximum allowed term length.

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.

getMinimumLength

public java.lang.Integer getMinimumLength()

Gets the minimum length allowed for a term (inclusive). A null value means no minimum.

Returns:

The minimum length allowed for a term.

setMinimumLength

public void setMinimumLength(java.lang.Integer minimumLength)

Gets the minimum length allowed for a term (inclusive). A null value means no minimum.

Parameters:

minimumLength - The minimum length allowed for a term. Must be non-negative.

getMaximumLength

public java.lang.Integer getMaximumLength()

Gets the maximum length allowed for a term (inclusive). A null value means no maximum.

Returns:

The maximum length allowed for a term.

setMaximumLength

public void setMaximumLength(java.lang.Integer maximumLength)

Gets the maximum length allowed for a term (inclusive). A null value means no maximum.

Parameters:

maximumLength - The maximum length allowed for a term. Must be positive.