org.apache.lucene.analysis.util
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.
As of Lucene 4.4, an
IllegalArgumentException
is thrown when trying to disable position
increments when filtering terms.
AttributeSource.AttributeFactory, AttributeSource.State
Modifier and Type | Field and Description |
---|---|
protected Version |
version |
input
Constructor and Description |
---|
FilteringTokenFilter(Version version,
boolean enablePositionIncrements,
TokenStream input)
Deprecated.
enablePositionIncrements=false is not supported anymore as of Lucene 4.4
|
FilteringTokenFilter(Version version,
TokenStream in)
Create a new
FilteringTokenFilter . |
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() . |
void |
end() |
boolean |
getEnablePositionIncrements() |
boolean |
incrementToken() |
void |
reset() |
void |
setEnablePositionIncrements(boolean enable)
Deprecated.
enablePositionIncrements=false is not supported anymore as of Lucene 4.4
|
close
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
protected final Version version
@Deprecated public FilteringTokenFilter(Version version, boolean enablePositionIncrements, TokenStream input)
FilteringTokenFilter
.version
- the Lucene match versionenablePositionIncrements
- whether to increment position increments when filtering out termsinput
- the input to consumepublic FilteringTokenFilter(Version version, TokenStream in)
FilteringTokenFilter
.version
- the Lucene match versionin
- the TokenStream
to consumeprotected 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)
@Deprecated 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.
public void end() throws IOException
end
in class TokenFilter
IOException
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.