Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
Lucene::WordlistLoader Class Reference

Loader for text files that represent a list of stopwords. More...

#include <WordlistLoader.h>

+ Inheritance diagram for Lucene::WordlistLoader:

Public Member Functions

virtual ~WordlistLoader ()
 
virtual String getClassName ()
 
boost::shared_ptr< WordlistLoadershared_from_this ()
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 
static HashSet< String > getWordSet (const String &wordfile, const String &comment=EmptyString)
 Loads a text file and adds every line as an entry to a HashSet (omitting leading and trailing whitespace). Every line of the file should contain only one word. The words need to be in lowercase if you make use of an Analyzer which uses LowerCaseFilter (like StandardAnalyzer).
 
static HashSet< String > getWordSet (const ReaderPtr &reader, const String &comment=EmptyString)
 Loads a text file and adds every line as an entry to a HashSet (omitting leading and trailing whitespace). Every line of the file should contain only one word. The words need to be in lowercase if you make use of an Analyzer which uses LowerCaseFilter (like StandardAnalyzer).
 
static MapStringString getStemDict (const String &wordstemfile)
 Reads a stem dictionary. Each line contains:
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

Loader for text files that represent a list of stopwords.

Constructor & Destructor Documentation

◆ ~WordlistLoader()

virtual Lucene::WordlistLoader::~WordlistLoader ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::WordlistLoader::_getClassName ( )
inlinestatic

◆ getClassName()

virtual String Lucene::WordlistLoader::getClassName ( )
inlinevirtual

◆ getStemDict()

static MapStringString Lucene::WordlistLoader::getStemDict ( const String &  wordstemfile)
static

Reads a stem dictionary. Each line contains:

word\tstem

(ie. two tab separated words)

Returns
stem dictionary that overrules the stemming algorithm

◆ getWordSet() [1/2]

static HashSet< String > Lucene::WordlistLoader::getWordSet ( const ReaderPtr reader,
const String &  comment = EmptyString 
)
static

Loads a text file and adds every line as an entry to a HashSet (omitting leading and trailing whitespace). Every line of the file should contain only one word. The words need to be in lowercase if you make use of an Analyzer which uses LowerCaseFilter (like StandardAnalyzer).

Parameters
readerReader containing the wordlist
commentThe comment string to ignore
Returns
A set with the file's words

◆ getWordSet() [2/2]

static HashSet< String > Lucene::WordlistLoader::getWordSet ( const String &  wordfile,
const String &  comment = EmptyString 
)
static

Loads a text file and adds every line as an entry to a HashSet (omitting leading and trailing whitespace). Every line of the file should contain only one word. The words need to be in lowercase if you make use of an Analyzer which uses LowerCaseFilter (like StandardAnalyzer).

Parameters
wordfileFile name containing the wordlist
commentThe comment string to ignore
Returns
A set with the file's words

◆ shared_from_this()

boost::shared_ptr< WordlistLoader > Lucene::WordlistLoader::shared_from_this ( )
inline

The documentation for this class was generated from the following file:

clucene.sourceforge.net