Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

Xapian::Stem Class Reference

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

#include <stem.h>

Collaboration diagram for Xapian::Stem:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Stem ()
 Create a stemmer object which leaves words unchanged.
 Stem (const std::string &language)
 Create a new stemmer object.
 ~Stem ()
 Standard destructor.
 Stem (const Stem &)
 Copying is allowed.
void operator= (const Stem &)
 Assignment is allowed.
std::string stem_word (const std::string &word) const
 Stem a word.
std::string get_description () const
 Returns a string representing the omstem object.

Static Public Member Functions

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

Public Attributes

Xapian::Internal::RefCntPtr<
Internal > 
internal
 Reference counted internals.

Detailed Description

This class provides an interface to the stemming algorithms.


Constructor & Destructor Documentation

Xapian::Stem::Stem  ) 
 

Create a stemmer object which leaves words unchanged.

Xapian::Stem::Stem 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:
Xapian::InvalidArgumentError will be thrown if an unknown language is supplied.

Xapian::Stem::~Stem  ) 
 

Standard destructor.

Xapian::Stem::Stem const Stem  ) 
 

Copying is allowed.


Member Function Documentation

std::string Xapian::Stem::get_available_languages  )  [static]
 

Return a list of available languages.

The list is returned as a space-separated string. A Xapian::Stem object is not required for this operation.

std::string Xapian::Stem::get_description  )  const
 

Returns a string representing the omstem object.

Introspection method.

void Xapian::Stem::operator= const Stem  ) 
 

Assignment is allowed.

std::string Xapian::Stem::stem_word const std::string &  word  )  const
 

Stem a word.

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


Member Data Documentation

Xapian::Internal::RefCntPtr<Internal> Xapian::Stem::internal
 

Reference counted internals.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.8.5).
Generated on 23 Dec 2004 by Doxygen 1.3.8.