public abstract class FilteringTokenFilter extends TokenFilter
accept()
and return a boolean if the current
token should be preserved. incrementToken()
uses this method
to decide if a token should be passed to the caller.AttributeSource.AttributeFactory, AttributeSource.State
input
Constructor and Description |
---|
FilteringTokenFilter(boolean enablePositionIncrements,
TokenStream input) |
Modifier and Type | Method and Description |
---|---|
protected abstract boolean |
accept()
Override this method and return if the current input token should be returned by
incrementToken() . |
boolean |
getEnablePositionIncrements() |
boolean |
incrementToken() |
void |
reset() |
void |
setEnablePositionIncrements(boolean enable)
If
true , this TokenFilter will preserve
positions of the incoming tokens (ie, accumulate and
set position increments of the removed tokens). |
close, end
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState
public FilteringTokenFilter(boolean enablePositionIncrements, TokenStream input)
protected abstract boolean accept() throws IOException
incrementToken()
.IOException
public final boolean incrementToken() throws IOException
incrementToken
in class TokenStream
IOException
public void reset() throws IOException
reset
in class TokenFilter
IOException
public boolean getEnablePositionIncrements()
setEnablePositionIncrements(boolean)
public void setEnablePositionIncrements(boolean enable)
true
, this TokenFilter will preserve
positions of the incoming tokens (ie, accumulate and
set position increments of the removed tokens).
Generally, true
is best as it does not
lose information (positions of the original tokens)
during indexing.
When set, when a token is stopped (omitted), the position increment of the following token is incremented.
NOTE: be sure to also set org.apache.lucene.queryparser.classic.QueryParser#setEnablePositionIncrements if you use QueryParser to create queries.
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.