Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

OmStem Class Reference

This class provides an interface to the stemming algorithms. More...

#include <omstem.h>

List of all members.

Public Methods

 OmStem (const std::string &language)
 Create a new stemmer object. More...

 ~OmStem ()
 Standard destructor. More...

 OmStem (const OmStem &)
 Copying is allowed. More...

void operator= (const OmStem &)
 Assignment is allowed. More...

std::string stem_word (const std::string &word) const
 Stem a word. More...

std::string get_description () const
 Returns a string representing the omstem object. More...


Static Public Methods

std::string get_available_languages ()
 Return a list of available languages. More...


Public Attributes

Internal * internal


Detailed Description

This class provides an interface to the stemming algorithms.


Constructor & Destructor Documentation

OmStem::OmStem const std::string &    language [explicit]
 

Create a new stemmer object.

Parameters:
language  a string specifying the language being used. This can either be the english name of the language, or the two letter ISO 639 (version 1) language code.
Exceptions:
OmInvalidArgumentError  will be thrown if an unknown language is supplied.

OmStem::~OmStem  
 

Standard destructor.

OmStem::OmStem const OmStem &   
 

Copying is allowed.


Member Function Documentation

std::string OmStem::get_available_languages   [static]
 

Return a list of available languages.

The list is returned as a space-separated string. An OmStem object is not required for this operation.

std::string OmStem::get_description   const
 

Returns a string representing the omstem object.

Introspection method.

void OmStem::operator= const OmStem &   
 

Assignment is allowed.

std::string OmStem::stem_word const std::string &    word const
 

Stem a word.

Parameters:
word  the word to stem.
Returns:
a stemmed version of the word.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.4.1cvs).
Generated on 20 Sep 2002 by Doxygen 1.2.15.