XapianTermGenerator: Xapian-GLib Reference Manual

XapianTermGenerator

XapianTermGenerator — Document indexer

Functions

XapianTermGenerator *	xapian_term_generator_new ()
void	xapian_term_generator_index_text ()
void	xapian_term_generator_index_text_full ()
void	xapian_term_generator_set_database ()
void	xapian_term_generator_set_document ()
void	xapian_term_generator_set_flags ()
void	xapian_term_generator_set_stemmer ()
void	xapian_term_generator_set_stemming_strategy ()
void	xapian_term_generator_set_stopper ()

Properties

XapianWritableDatabase *	database	Read / Write
XapianDocument *	document	Read / Write
XapianTermGeneratorFeature	flags	Write
XapianStem *	stemmer	Read / Write
XapianStemStrategy	stemming-strategy	Read / Write
XapianStopper *	stopper	Read / Write

Types and Values

enum	XapianTermGeneratorFeature

Object Hierarchy

    GFlags
    ╰── XapianTermGeneratorFeature
    GObject
    ╰── XapianTermGenerator

Description

XapianTermGenerator is a class used to index document data.

Functions

xapian_term_generator_new ()

XapianTermGenerator *
xapian_term_generator_new (void);

Creates a new XapianTermGenerator instance.

Returns

the newly created XapianTermGenerator.

[transfer full]

xapian_term_generator_index_text ()

void
xapian_term_generator_index_text (XapianTermGenerator *generator,
                                  const char *data);

Indexes data into the current document.

Parameters

generator	a XapianTermGenerator
data	the data to be indexed

xapian_term_generator_index_text_full ()

void
xapian_term_generator_index_text_full (XapianTermGenerator *generator,
                                       const char *data,
                                       unsigned int wdf_inc,
                                       const char *prefix);

Indexes data into the current document.

Unlike xapian_term_generator_index_text(), this function also allows setting the WDF increment and the default prefix for the indexed data.

Parameters

generator	a XapianTermGenerator
data	the data to be indexed
wdf_inc	the increment of the WDF
prefix	the default prefix for the indexed data

xapian_term_generator_set_database ()

void
xapian_term_generator_set_database (XapianTermGenerator *generator,
                                    XapianWritableDatabase *database);

Sets the database used to store the indexed data.

Parameters

generator	a XapianTermGenerator
database	a XapianWritableDatabase

xapian_term_generator_set_document ()

void
xapian_term_generator_set_document (XapianTermGenerator *generator,
                                    XapianDocument *document);

Sets the current document.

Parameters

generator	a XapianTermGenerator
document	a XapianDocument

xapian_term_generator_set_flags ()

void
xapian_term_generator_set_flags (XapianTermGenerator *generator,
                                 XapianTermGeneratorFeature flags);

Sets the generator's flags

Parameters

generator	a XapianTermGenerator
flags	a XapianTermGeneratorFeature

Since: 1.2

xapian_term_generator_set_stemmer ()

void
xapian_term_generator_set_stemmer (XapianTermGenerator *generator,
                                   XapianStem *stemmer);

Sets the stemmer for generator .

Parameters

generator	a XapianTermGenerator
stemmer	a XapianStem

xapian_term_generator_set_stemming_strategy ()

void
xapian_term_generator_set_stemming_strategy
                               (XapianTermGenerator *generator,
                                XapianStemStrategy strategy);

Sets the stemming strategy for generator .

Parameters

generator	a XapianTermGenerator
strategy	a XapianStemStrategy value

xapian_term_generator_set_stopper ()

void
xapian_term_generator_set_stopper (XapianTermGenerator *generator,
                                   XapianStopper *stopper);

Sets the stopper for generator .

Parameters

generator	a XapianTermGenerator
stopper	a XapianStopper

Since: 1.4

Types and Values

enum XapianTermGeneratorFeature

TermGenerator flags

Members

XAPIAN_TERM_GENERATOR_FEATURE_NONE	No features
XAPIAN_TERM_GENERATOR_FEATURE_SPELLING	Index data required for spelling correction

Since: 1.2

Property Details

The `“database”` property

  “database”                 XapianWritableDatabase *

The XapianWritableDatabase instance used to store the indexed data.

Flags: Read / Write

The `“document”` property

  “document”                 XapianDocument *

The currently indexed document.

Flags: Read / Write

The `“flags”` property

  “flags”                    XapianTermGeneratorFeature

Flags affecting this object's behaviour; see XapianTermGeneratorFeature.

Flags: Write

The `“stemmer”` property

  “stemmer”                  XapianStem *

The XapianStem instance used for stemming the indexed data.

The value of this property is only used when the “stemming-strategy” property is set to a value different than XAPIAN_STEM_STRATEGY_STEM_NONE.

Flags: Read / Write

The `“stemming-strategy”` property

  “stemming-strategy”        XapianStemStrategy

The stemming strategy to use when the “stemmer” property is set.

Flags: Read / Write

Default value: XAPIAN_STEM_STRATEGY_STEM_NONE

The `“stopper”` property

  “stopper”                  XapianStopper *

The stopper to be used when filtering stop-words.

Flags: Read / Write

Since: 1.4