public final class ValidatingTokenFilter extends TokenFilter
AttributeSource.AttributeFactory, AttributeSource.State
input
Constructor and Description |
---|
ValidatingTokenFilter(TokenStream in,
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).
|
Modifier and Type | Method and Description |
---|---|
void |
end()
Performs end-of-stream operations, if any, and calls then
end() on the
input TokenStream. |
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
void |
reset()
Reset the filter as well as the input TokenStream.
|
close
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
public ValidatingTokenFilter(TokenStream in, String name, boolean offsetsAreCorrect)
public boolean incrementToken() throws IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
s with the attributes of the next
token.
The producer must make no assumptions about the attributes after the method
has been returned: the caller may arbitrarily change it. If the producer
needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.
This method is called for every token of a document, so an efficient
implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
s that this stream uses should be
retrieved during instantiation.
To ensure that filters and consumers know which attributes are available,
the attributes must be added during instantiation. Filters and consumers
are not required to check for availability of attributes in
TokenStream.incrementToken()
.
incrementToken
in class TokenStream
IOException
public void end() throws IOException
TokenFilter
end()
on the
input TokenStream.
NOTE: Be sure to call super.end()
first when overriding this method.end
in class TokenFilter
IOException
public void reset() throws IOException
TokenFilter
reset
in class TokenFilter
IOException