public final class StopFilter extends TokenFilter
AttributeSource.AttributeFactory, AttributeSource.State
input
Constructor and Description |
---|
StopFilter(boolean enablePositionIncrements,
TokenStream in,
java.util.Set stopWords)
Constructs a filter which removes words from the input
TokenStream that are named in the Set.
|
StopFilter(boolean enablePositionIncrements,
TokenStream input,
java.util.Set stopWords,
boolean ignoreCase)
Construct a token stream filtering the given input.
|
StopFilter(boolean enablePositionIncrements,
TokenStream input,
java.lang.String[] stopWords)
Deprecated.
Use
StopFilter(boolean, TokenStream, Set) instead. |
StopFilter(boolean enablePositionIncrements,
TokenStream in,
java.lang.String[] stopWords,
boolean ignoreCase)
Deprecated.
Use
StopFilter(boolean, TokenStream, Set, boolean) instead. |
StopFilter(TokenStream in,
java.util.Set stopWords)
Deprecated.
Use
StopFilter(boolean, TokenStream, Set) instead |
StopFilter(TokenStream input,
java.util.Set stopWords,
boolean ignoreCase)
Deprecated.
Use
StopFilter(boolean, TokenStream, Set, boolean) instead |
StopFilter(TokenStream input,
java.lang.String[] stopWords)
Deprecated.
Use
StopFilter(boolean, TokenStream, String[]) instead |
StopFilter(TokenStream in,
java.lang.String[] stopWords,
boolean ignoreCase)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
getEnablePositionIncrements() |
static boolean |
getEnablePositionIncrementsDefault()
Deprecated.
Please specify this when you create the StopFilter
|
static boolean |
getEnablePositionIncrementsVersionDefault(Version matchVersion)
Returns version-dependent default for
enablePositionIncrements.
|
boolean |
incrementToken()
Returns the next input Token whose term() is not a stop word.
|
void |
init() |
static java.util.Set |
makeStopSet(java.util.List stopWords)
Builds a Set from an array of stop words,
appropriate for passing into the StopFilter constructor.
|
static java.util.Set |
makeStopSet(java.util.List stopWords,
boolean ignoreCase) |
static java.util.Set |
makeStopSet(java.lang.String[] stopWords)
Builds a Set from an array of stop words,
appropriate for passing into the StopFilter constructor.
|
static java.util.Set |
makeStopSet(java.lang.String[] stopWords,
boolean ignoreCase) |
void |
setEnablePositionIncrements(boolean enable)
If
true , this StopFilter will preserve
positions of the incoming tokens (ie, accumulate and
set position increments of the removed stop tokens). |
static void |
setEnablePositionIncrementsDefault(boolean defaultValue)
Deprecated.
Please specify this when you create the StopFilter
|
close, end, reset
getOnlyUseNewAPI, next, next, setOnlyUseNewAPI
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString
public StopFilter(TokenStream input, java.lang.String[] stopWords)
StopFilter(boolean, TokenStream, String[])
insteadpublic StopFilter(boolean enablePositionIncrements, TokenStream input, java.lang.String[] stopWords)
StopFilter(boolean, TokenStream, Set)
instead.enablePositionIncrements
- true if token positions should record the removed stop wordsinput
- input TokenStreamstopWords
- array of stop wordspublic StopFilter(TokenStream in, java.lang.String[] stopWords, boolean ignoreCase)
StopFilter(boolean, TokenStream, String[], boolean)
insteadpublic StopFilter(boolean enablePositionIncrements, TokenStream in, java.lang.String[] stopWords, boolean ignoreCase)
StopFilter(boolean, TokenStream, Set, boolean)
instead.enablePositionIncrements
- true if token positions should record the removed stop wordsin
- input TokenStreamstopWords
- array of stop wordsignoreCase
- true if case is ignoredpublic StopFilter(TokenStream input, java.util.Set stopWords, boolean ignoreCase)
StopFilter(boolean, TokenStream, Set, boolean)
insteadstopWords
is an instance of CharArraySet
(true if
makeStopSet()
was used to construct the set) it will be directly used
and ignoreCase
will be ignored since CharArraySet
directly controls case sensitivity.
If stopWords
is not an instance of CharArraySet
,
a new CharArraySet will be constructed and ignoreCase
will be
used to specify the case sensitivity of that set.input
- stopWords
- The set of Stop Words.ignoreCase
- -Ignore case when stopping.public StopFilter(boolean enablePositionIncrements, TokenStream input, java.util.Set stopWords, boolean ignoreCase)
stopWords
is an instance of CharArraySet
(true if
makeStopSet()
was used to construct the set) it will be directly used
and ignoreCase
will be ignored since CharArraySet
directly controls case sensitivity.
If stopWords
is not an instance of CharArraySet
,
a new CharArraySet will be constructed and ignoreCase
will be
used to specify the case sensitivity of that set.enablePositionIncrements
- true if token positions should record the removed stop wordsinput
- Input TokenStreamstopWords
- The set of Stop Words.ignoreCase
- -Ignore case when stopping.public StopFilter(TokenStream in, java.util.Set stopWords)
StopFilter(boolean, TokenStream, Set)
insteadmakeStopSet(java.lang.String[])
public StopFilter(boolean enablePositionIncrements, TokenStream in, java.util.Set stopWords)
enablePositionIncrements
- true if token positions should record the removed stop wordsin
- Input streamstopWords
- The set of Stop Words.makeStopSet(java.lang.String[])
public void init()
public static final java.util.Set makeStopSet(java.lang.String[] stopWords)
passing false to ignoreCase
public static final java.util.Set makeStopSet(java.util.List stopWords)
passing false to ignoreCase
public static final java.util.Set makeStopSet(java.lang.String[] stopWords, boolean ignoreCase)
stopWords
- An array of stopwordsignoreCase
- If true, all words are lower cased first.public static final java.util.Set makeStopSet(java.util.List stopWords, boolean ignoreCase)
stopWords
- A List of Strings representing the stopwordsignoreCase
- if true, all words are lower cased firstpublic final boolean incrementToken() throws java.io.IOException
incrementToken
in class TokenStream
Note that this method will be defined abstract in Lucene 3.0.
java.io.IOException
public static boolean getEnablePositionIncrementsDefault()
public static boolean getEnablePositionIncrementsVersionDefault(Version matchVersion)
getEnablePositionIncrementsDefault()
.
On 2.9 or later, it returns true.public static void setEnablePositionIncrementsDefault(boolean defaultValue)
Note: behavior of a single StopFilter instance can be modified
with setEnablePositionIncrements(boolean)
.
This static method allows control over behavior of classes using StopFilters internally,
for example StandardAnalyzer
if used with the no-arg ctor.
Default : false.
setEnablePositionIncrements(boolean).
public boolean getEnablePositionIncrements()
setEnablePositionIncrements(boolean).
public void setEnablePositionIncrements(boolean enable)
true
, this StopFilter will preserve
positions of the incoming tokens (ie, accumulate and
set position increments of the removed stop 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 QueryParser.setEnablePositionIncrements(boolean)
if
you use QueryParser to create queries.
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.