|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.analysis.Analyzer org.apache.lucene.analysis.AnalyzerWrapper org.apache.lucene.analysis.shingle.ShingleAnalyzerWrapper
public final class ShingleAnalyzerWrapper
A ShingleAnalyzerWrapper wraps a ShingleFilter
around another Analyzer
.
A shingle is another name for a token based n-gram.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer |
---|
Analyzer.GlobalReuseStrategy, Analyzer.PerFieldReuseStrategy, Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents |
Constructor Summary | |
---|---|
ShingleAnalyzerWrapper(Analyzer defaultAnalyzer)
|
|
ShingleAnalyzerWrapper(Analyzer defaultAnalyzer,
int maxShingleSize)
|
|
ShingleAnalyzerWrapper(Analyzer defaultAnalyzer,
int minShingleSize,
int maxShingleSize)
|
|
ShingleAnalyzerWrapper(Analyzer defaultAnalyzer,
int minShingleSize,
int maxShingleSize,
String tokenSeparator,
boolean outputUnigrams,
boolean outputUnigramsIfNoShingles)
Creates a new ShingleAnalyzerWrapper |
|
ShingleAnalyzerWrapper(Version matchVersion)
Wraps StandardAnalyzer . |
|
ShingleAnalyzerWrapper(Version matchVersion,
int minShingleSize,
int maxShingleSize)
Wraps StandardAnalyzer . |
Method Summary | |
---|---|
int |
getMaxShingleSize()
The max shingle (token ngram) size |
int |
getMinShingleSize()
The min shingle (token ngram) size |
String |
getTokenSeparator()
|
protected Analyzer |
getWrappedAnalyzer(String fieldName)
|
boolean |
isOutputUnigrams()
|
boolean |
isOutputUnigramsIfNoShingles()
|
protected Analyzer.TokenStreamComponents |
wrapComponents(String fieldName,
Analyzer.TokenStreamComponents components)
|
Methods inherited from class org.apache.lucene.analysis.AnalyzerWrapper |
---|
createComponents, getOffsetGap, getPositionIncrementGap, initReader |
Methods inherited from class org.apache.lucene.analysis.Analyzer |
---|
close, tokenStream |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ShingleAnalyzerWrapper(Analyzer defaultAnalyzer)
public ShingleAnalyzerWrapper(Analyzer defaultAnalyzer, int maxShingleSize)
public ShingleAnalyzerWrapper(Analyzer defaultAnalyzer, int minShingleSize, int maxShingleSize)
public ShingleAnalyzerWrapper(Analyzer defaultAnalyzer, int minShingleSize, int maxShingleSize, String tokenSeparator, boolean outputUnigrams, boolean outputUnigramsIfNoShingles)
defaultAnalyzer
- Analyzer whose TokenStream is to be filteredminShingleSize
- Min shingle (token ngram) sizemaxShingleSize
- Max shingle sizetokenSeparator
- Used to separate input stream tokens in output shinglesoutputUnigrams
- Whether or not the filter shall pass the original
tokens to the output streamoutputUnigramsIfNoShingles
- Overrides the behavior of outputUnigrams==false for those
times when no shingles are available (because there are fewer than
minShingleSize tokens in the input stream)?
Note that if outputUnigrams==true, then unigrams are always output,
regardless of whether any shingles are available.public ShingleAnalyzerWrapper(Version matchVersion)
StandardAnalyzer
.
public ShingleAnalyzerWrapper(Version matchVersion, int minShingleSize, int maxShingleSize)
StandardAnalyzer
.
Method Detail |
---|
public int getMaxShingleSize()
public int getMinShingleSize()
public String getTokenSeparator()
public boolean isOutputUnigrams()
public boolean isOutputUnigramsIfNoShingles()
protected Analyzer getWrappedAnalyzer(String fieldName)
getWrappedAnalyzer
in class AnalyzerWrapper
protected Analyzer.TokenStreamComponents wrapComponents(String fieldName, Analyzer.TokenStreamComponents components)
wrapComponents
in class AnalyzerWrapper
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |