|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.StopFilter
public final class StopFilter
Removes stop words from a token stream.
Field Summary |
---|
Fields inherited from class org.apache.lucene.analysis.TokenFilter |
---|
input |
Constructor Summary | |
---|---|
StopFilter(TokenStream in,
Set stopWords)
Constructs a filter which removes words from the input TokenStream that are named in the Set. |
|
StopFilter(TokenStream input,
Set stopWords,
boolean ignoreCase)
Construct a token stream filtering the given input. |
|
StopFilter(TokenStream input,
String[] stopWords)
Construct a token stream filtering the given input. |
|
StopFilter(TokenStream in,
String[] stopWords,
boolean ignoreCase)
Constructs a filter which removes words from the input TokenStream that are named in the array of words. |
Method Summary | |
---|---|
boolean |
getEnablePositionIncrements()
|
static boolean |
getEnablePositionIncrementsDefault()
|
static Set |
makeStopSet(String[] stopWords)
Builds a Set from an array of stop words, appropriate for passing into the StopFilter constructor. |
static Set |
makeStopSet(String[] stopWords,
boolean ignoreCase)
|
Token |
next(Token result)
Returns the next input Token whose termText() is not a stop word. |
void |
setEnablePositionIncrements(boolean enable)
Set to true to make this StopFilter enable position increments to result tokens. |
static void |
setEnablePositionIncrementsDefault(boolean defaultValue)
Set the default position increments behavior of every StopFilter created from now on. |
Methods inherited from class org.apache.lucene.analysis.TokenFilter |
---|
close |
Methods inherited from class org.apache.lucene.analysis.TokenStream |
---|
next, reset |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StopFilter(TokenStream input, String[] stopWords)
public StopFilter(TokenStream in, String[] stopWords, boolean ignoreCase)
public StopFilter(TokenStream input, 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.
input
- stopWords
- The set of Stop Words.ignoreCase
- -Ignore case when stopping.public StopFilter(TokenStream in, Set stopWords)
makeStopSet(java.lang.String[])
Method Detail |
---|
public static final Set makeStopSet(String[] stopWords)
passing false to ignoreCase
public static final Set makeStopSet(String[] stopWords, boolean ignoreCase)
stopWords
- ignoreCase
- If true, all words are lower cased first.
public final Token next(Token result) throws IOException
next
in class TokenStream
result
- a Token that may or may not be used to return
IOException
public static boolean getEnablePositionIncrementsDefault()
setEnablePositionIncrementsDefault(boolean).
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
.
Default : false.
setEnablePositionIncrements(boolean).
public boolean getEnablePositionIncrements()
setEnablePositionIncrements(boolean).
public void setEnablePositionIncrements(boolean enable)
true
to make this StopFilter enable position increments to result tokens.
When set, when a token is stopped (omitted), the position increment of the following token is incremented.
Default: see setEnablePositionIncrementsDefault(boolean)
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |