Class StopwordAnalyzerBase
Base class for Lucene.Net.Analysis.Analyzers that need to make use of stopword sets.
Inheritance
Implements
Inherited Members
Namespace: Lucene.Net.Analysis.Util
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public abstract class StopwordAnalyzerBase : Analyzer, IDisposable
Constructors
| Improve this Doc View SourceStopwordAnalyzerBase(LuceneVersion)
Creates a new Lucene.Net.Analysis.Analyzer with an empty stopword set
Declaration
protected StopwordAnalyzerBase(LuceneVersion version)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Util.LuceneVersion | version | the Lucene version for cross version compatibility |
StopwordAnalyzerBase(LuceneVersion, CharArraySet)
Creates a new instance initialized with the given stopword set
Declaration
protected StopwordAnalyzerBase(LuceneVersion version, CharArraySet stopwords)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Util.LuceneVersion | version | the Lucene version for cross version compatibility |
CharArraySet | stopwords | the analyzer's stopword set |
Fields
| Improve this Doc View Sourcem_matchVersion
Declaration
protected readonly LuceneVersion m_matchVersion
Field Value
Type | Description |
---|---|
Lucene.Net.Util.LuceneVersion |
m_stopwords
An immutable stopword set
Declaration
protected readonly CharArraySet m_stopwords
Field Value
Type | Description |
---|---|
CharArraySet |
Properties
| Improve this Doc View SourceStopwordSet
Returns the analyzer's stopword set or an empty set if the analyzer has no stopwords
Declaration
public virtual CharArraySet StopwordSet { get; }
Property Value
Type | Description |
---|---|
CharArraySet | the analyzer's stopword set or an empty set if the analyzer has no stopwords |
Methods
| Improve this Doc View SourceLoadStopwordSet(Boolean, Type, String, String)
Creates a CharArraySet from an embedded resource associated with a class. (See System.Reflection.Assembly.GetManifestResourceStream(System.String)).
Declaration
protected static CharArraySet LoadStopwordSet(bool ignoreCase, Type aClass, string resource, string comment)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | ignoreCase |
|
System.Type | aClass | a class that is associated with the given stopwordResource |
System.String | resource | name of the resource file associated with the given class |
System.String | comment | comment string to ignore in the stopword file |
Returns
Type | Description |
---|---|
CharArraySet | a CharArraySet containing the distinct stopwords from the given file |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if loading the stopwords throws an System.IO.IOException |
LoadStopwordSet(FileInfo, LuceneVersion)
Creates a CharArraySet from a file.
Declaration
protected static CharArraySet LoadStopwordSet(FileInfo stopwords, LuceneVersion matchVersion)
Parameters
Type | Name | Description |
---|---|---|
System.IO.FileInfo | stopwords | the stopwords file to load |
Lucene.Net.Util.LuceneVersion | matchVersion | the Lucene version for cross version compatibility |
Returns
Type | Description |
---|---|
CharArraySet | a CharArraySet containing the distinct stopwords from the given file |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if loading the stopwords throws an System.IO.IOException |
LoadStopwordSet(TextReader, LuceneVersion)
Creates a CharArraySet from a file.
Declaration
protected static CharArraySet LoadStopwordSet(TextReader stopwords, LuceneVersion matchVersion)
Parameters
Type | Name | Description |
---|---|---|
System.IO.TextReader | stopwords | the stopwords reader to load |
Lucene.Net.Util.LuceneVersion | matchVersion | the Lucene version for cross version compatibility |
Returns
Type | Description |
---|---|
CharArraySet | a CharArraySet containing the distinct stopwords from the given reader |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if loading the stopwords throws an System.IO.IOException |