Package oxygen

Class OxygenAnalyzerBase

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.StopwordAnalyzerBase

oxygen.OxygenAnalyzerBase

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

OxygenAnalyzerWithShingles

public class OxygenAnalyzerBase
extends org.apache.lucene.analysis.StopwordAnalyzerBase

Base version of Oxygen Custom Analyzer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	OxygenAnalyzerBase.DefaultSetHolder	Atomically loads the DEFAULT_STOP_SET in a lazy fashion once the outer class accesses the static final set the first time.;

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.Analyzer.ReuseStrategy, org.apache.lucene.analysis.Analyzer.TokenStreamComponents

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.lucene.analysis.CharArraySet	OXYGEN_EXCLUSION_SET
protected org.apache.lucene.analysis.CharArraySet	stemExclusionSet
protected org.apache.lucene.analysis.CharArraySet	stopwords

Fields inherited from class org.apache.lucene.analysis.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
OxygenAnalyzerBase()	Creates default Oxygen Analyzer
OxygenAnalyzerBase(org.apache.lucene.analysis.CharArraySet stopWords)	Builds an analyzer with the given stop words.
OxygenAnalyzerBase(org.apache.lucene.analysis.CharArraySet stopWords, org.apache.lucene.analysis.CharArraySet stemExclusionSet)	Builds an analyzer with the given stop words.

Method Summary

Modifier and Type	Method	Description
protected org.apache.lucene.analysis.Analyzer.TokenStreamComponents	createComponents(java.lang.String fieldName)
static org.apache.lucene.analysis.CharArraySet	getDefaultStopSet()	Returns an unmodifiable instance of the default stop words set.
static java.lang.String	getShingleInfo()
protected org.apache.lucene.analysis.TokenStream	normalize(java.lang.String fieldName, org.apache.lucene.analysis.TokenStream in)

Methods inherited from class org.apache.lucene.analysis.Analyzer

attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, getVersion, initReader, initReaderForNormalization, normalize, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase

getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet

Field Detail

OXYGEN_EXCLUSION_SET

public static final org.apache.lucene.analysis.CharArraySet OXYGEN_EXCLUSION_SET

stemExclusionSet

protected final org.apache.lucene.analysis.CharArraySet stemExclusionSet

stopwords

protected final org.apache.lucene.analysis.CharArraySet stopwords

Constructor Detail

OxygenAnalyzerBase

public OxygenAnalyzerBase()

Creates default Oxygen Analyzer

OxygenAnalyzerBase

public OxygenAnalyzerBase(org.apache.lucene.analysis.CharArraySet stopWords,
                          org.apache.lucene.analysis.CharArraySet stemExclusionSet)

Builds an analyzer with the given stop words. If a non-empty stem exclusion set is provided this analyzer will add a SetKeywordMarkerFilter before stemming.

Parameters:

stopWords - a stopword set

stemExclusionSet - a set of terms not to be stemmed

OxygenAnalyzerBase

public OxygenAnalyzerBase(org.apache.lucene.analysis.CharArraySet stopWords)

Builds an analyzer with the given stop words.

Parameters:

stopWords - a stopword set

Method Detail

getDefaultStopSet

public static org.apache.lucene.analysis.CharArraySet getDefaultStopSet()

Returns an unmodifiable instance of the default stop words set.

Returns:

default stop words set.

getShingleInfo

public static java.lang.String getShingleInfo()

Returns:

Oxygen Analyzer type

normalize

protected org.apache.lucene.analysis.TokenStream normalize(java.lang.String fieldName,
                                                           org.apache.lucene.analysis.TokenStream in)

Overrides:

normalize in class org.apache.lucene.analysis.Analyzer

createComponents

protected org.apache.lucene.analysis.Analyzer.TokenStreamComponents createComponents(java.lang.String fieldName)

Specified by:

createComponents in class org.apache.lucene.analysis.Analyzer