# Xapian::TermGenerator Class Reference

Parses a piece of text and generate terms. More...

`#include <termgenerator.h>`

List of all members.

## Public Types

enum | flags { FLAG_SPELLING = 128 }
| Flags to OR together and pass to TermGenerator::set_flags(). More...

## Public Member Functions

| TermGenerator (const TermGenerator &o)
| Copy constructor.
TermGenerator & | operator= (const TermGenerator &o)
| Assignment.
| TermGenerator ()
| Default constructor.
| ~TermGenerator ()
| Destructor.
void | set_stemmer (const Xapian::Stem &stemmer)
| Set the Xapian::Stem object to be used for generating stemmed terms.
void | set_stopper (const Xapian::Stopper *stop=NULL)
| Set the Xapian::Stopper object to be used for identifying stopwords.
void | set_document (const Xapian::Document &doc)
| Set the current document.
const Xapian::Document & | get_document () const
| Get the current document.
void | set_database (const Xapian::WritableDatabase &db)
| Set the database to index spelling data to.
flags | set_flags (flags toggle, flags mask=flags(0))
| Set flags.
void | index_text (const Xapian::Utf8Iterator &itor, Xapian::termcount weight=1, const std::string &prefix="")
| Index some text.
void | index_text (const std::string &text, Xapian::termcount weight=1, const std::string &prefix="")
| Index some text in a std::string.
void | index_text_without_positions (const Xapian::Utf8Iterator &itor, Xapian::termcount weight=1, const std::string &prefix="")
| Index some text without positional information.
void | index_text_without_positions (const std::string &text, Xapian::termcount weight=1, const std::string &prefix="")
| Index some text in a std::string without positional information.
void | increase_termpos (Xapian::termcount delta=100)
| Increase the termpos used by index_text by delta.
Xapian::termcount | get_termpos () const
| Get the current term position.
void | set_termpos (Xapian::termcount termpos)
| Set the current term position.
std::string | get_description () const
| Return a string describing this object.

## Detailed Description

Parses a piece of text and generate terms.

This module takes a piece of text and parses it to produce words which are then used to generate suitable terms for indexing. The terms generated are suitable for use with Query objects produced by the QueryParser class.

## Member Enumeration Documentation

enum Xapian::TermGenerator::flags

Flags to OR together and pass to TermGenerator::set_flags().

Enumerator:

  FLAG_SPELLING | Index data required for spelling correction.

## Constructor & Destructor Documentation

Xapian::TermGenerator::TermGenerator | ( | const TermGenerator & | o | ) |

Copy constructor.

Xapian::TermGenerator::TermGenerator | ( |  | ) |

Default constructor.

Xapian::TermGenerator::~TermGenerator | ( |  | ) |

Destructor.

## Member Function Documentation

TermGenerator& Xapian::TermGenerator::operator= | ( | const TermGenerator & | o | ) |

Assignment.

void Xapian::TermGenerator::set_stemmer | ( | const Xapian::Stem & | stemmer | ) |

Set the Xapian::Stem object to be used for generating stemmed terms.

void Xapian::TermGenerator::set_stopper | ( | const Xapian::Stopper * | stop = `NULL` | ) |

Set the Xapian::Stopper object to be used for identifying stopwords.

void Xapian::TermGenerator::set_document | ( | const Xapian::Document & | doc | ) |

Set the current document.

const Xapian::Document& Xapian::TermGenerator::get_document | ( |  | ) | const

Get the current document.

void Xapian::TermGenerator::set_database | ( | const Xapian::WritableDatabase & | db | ) |

Set the database to index spelling data to.

flags Xapian::TermGenerator::set_flags | ( | flags | toggle,
|  | flags | mask = `flags(0)` |
| ) |  |  |

Set flags.

The new value of flags is: (flags & mask) ^ toggle

To just set the flags, pass the new flags in toggle and the default value for mask.

Parameters:

  | toggle | Flags to XOR.
  | mask | Flags to AND with first.

Returns:
  The old flags setting.

void Xapian::TermGenerator::index_text | ( | const Xapian::Utf8Iterator & | itor,
|  | Xapian::termcount | weight = `1`,
|  | const std::string & | prefix = `""` |
| ) |  |  |

Index some text.

Parameters:

  | weight | The wdf increment (default 1).
  | prefix | The term prefix to use (default is no prefix).

void Xapian::TermGenerator::index_text | ( | const std::string & | text,
|  | Xapian::termcount | weight = `1`,
|  | const std::string & | prefix = `""` |
| ) |  |  | `[inline]`

Index some text in a std::string.

Parameters:

  | weight | The wdf increment (default 1).
  | prefix | The term prefix to use (default is no prefix).

void Xapian::TermGenerator::index_text_without_positions | ( | const Xapian::Utf8Iterator & | itor,
|  | Xapian::termcount | weight = `1`,
|  | const std::string & | prefix = `""` |
| ) |  |  |

Index some text without positional information.

Just like index_text, but no positional information is generated. This means that the database will be significantly smaller, but that phrase searching and NEAR won't be supported.

void Xapian::TermGenerator::index_text_without_positions | ( | const std::string & | text,
|  | Xapian::termcount | weight = `1`,
|  | const std::string & | prefix = `""` |
| ) |  |  | `[inline]`

Index some text in a std::string without positional information.

Just like index_text, but no positional information is generated. This means that the database will be significantly smaller, but that phrase searching and NEAR won't be supported.

void Xapian::TermGenerator::increase_termpos | ( | Xapian::termcount | delta = `100` | ) |

Increase the termpos used by index_text by delta.

This can be used to prevent phrase searches from spanning two unconnected blocks of text (e.g. the title and body text).

Xapian::termcount Xapian::TermGenerator::get_termpos | ( |  | ) | const

Get the current term position.

void Xapian::TermGenerator::set_termpos | ( | Xapian::termcount | termpos | ) |

Set the current term position.

std::string Xapian::TermGenerator::get_description | ( |  | ) | const

Return a string describing this object.

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

- include/xapian/termgenerator.h