Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
zorba::Thesaurus Class Referenceabstract

A Thesaurus provides a way to look up related phrases for a given phrase. More...

#include <zorba/thesaurus.h>

Classes

class  iterator
 An iterator is used to iterate over lookup results. More...
 

Public Types

typedef std::unique_ptr
< Thesaurus const,
internal::ztd::destroy_delete
< Thesaurus const > > 
ptr
 
typedef unsigned range_type
 The integral type for "at least" and "at most" values. More...
 

Public Member Functions

virtual void destroy () const =0
 Destroys this Thesaurus. More...
 
virtual iterator::ptr lookup (String const &phrase, String const &relationship, range_type at_least, range_type at_most) const =0
 Looks-up the given phrase. More...
 

Protected Member Functions

virtual ~Thesaurus ()
 

Detailed Description

A Thesaurus provides a way to look up related phrases for a given phrase.

Definition at line 37 of file thesaurus.h.

Member Typedef Documentation

Definition at line 42 of file thesaurus.h.

typedef unsigned zorba::Thesaurus::range_type

The integral type for "at least" and "at most" values.

Definition at line 47 of file thesaurus.h.

Constructor & Destructor Documentation

virtual zorba::Thesaurus::~Thesaurus ( )
protectedvirtual

Member Function Documentation

virtual void zorba::Thesaurus::destroy ( ) const
pure virtual

Destroys this Thesaurus.

This function is called by Zorba when the Thesaurus is no longer needed.

If your implementation dynamically allocates Thesaurus objects, then your implementation can simply be (and usually is) delete this.

If your implementation returns a pointer to a static Thesaurus object, then your implementation should do nothing.

virtual iterator::ptr zorba::Thesaurus::lookup ( String const &  phrase,
String const &  relationship,
range_type  at_least,
range_type  at_most 
) const
pure virtual

Looks-up the given phrase.

Parameters
phraseThe phrase to look up.
relationshipThe relationship the synonyms are to have to the given phrase.
at_leastThe minimum number of levels within the thesaurus to be traversed.
at_mostThe maximum number of levels within the thesaurus to be traversed.
Returns
Returns a pointer to an iterator for the results or NULL if the phrase was not found.

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