org.apache.lucene.analysis

Class ValidatingTokenFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.ValidatingTokenFilter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

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

A TokenFilter that checks consistency of the tokens (eg offsets are consistent with one another).

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
ValidatingTokenFilter(org.apache.lucene.analysis.TokenStream in, java.lang.String name, boolean offsetsAreCorrect) The name arg is used to identify this stage when throwing exceptions (useful if you have more than one instance in your chain).

Method Summary

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

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

close

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

ValidatingTokenFilter

public ValidatingTokenFilter(org.apache.lucene.analysis.TokenStream in,
                             java.lang.String name,
                             boolean offsetsAreCorrect)

The name arg is used to identify this stage when throwing exceptions (useful if you have more than one instance in your chain).

Method Detail

incrementToken

public boolean incrementToken()
                       throws java.io.IOException

Specified by:

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

Throws:

java.io.IOException

end

public void end()
         throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException