org.apache.lucene.search.highlight

Class OffsetLimitTokenFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.search.highlight.OffsetLimitTokenFilter

All Implemented Interfaces:

Closeable

public final class OffsetLimitTokenFilter
extends org.apache.lucene.analysis.TokenFilter

This TokenFilter limits the number of tokens while indexing by adding up the current offset.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State

Field Summary

Fields inherited from class org.apache.lucene.analysis.TokenFilter

input

Constructor Summary

Constructors

Constructor and Description
OffsetLimitTokenFilter(org.apache.lucene.analysis.TokenStream input, int offsetLimit)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	incrementToken()
void	reset()

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, end

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OffsetLimitTokenFilter

public OffsetLimitTokenFilter(org.apache.lucene.analysis.TokenStream input,
                      int offsetLimit)

Method Detail

incrementToken

public boolean incrementToken()
                       throws IOException

Specified by:

incrementToken in class org.apache.lucene.analysis.TokenStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class org.apache.lucene.analysis.TokenFilter

Throws:

IOException