lucene::index::TermInfosWriter Class Reference

#include <TermInfosWriter.h>

Inheritance diagram for lucene::index::TermInfosWriter:

List of all members.

Public Member Functions
	LUCENE_STATIC_CONSTANT (int32_t, FORMAT=-2)
	The file format version, a negative number.
	TermInfosWriter (lucene::store::Directory *directory, const char *segment, FieldInfos *fis, int32_t interval)
	~TermInfosWriter ()
void	add (Term *term, const TermInfo *ti)
	Adds a new <Term, TermInfo> pair to the set.
void	close ()
	Called to complete TermInfos creation.
Public Attributes
int32_t	indexInterval
	Expert: The fraction of terms in the "dictionary" which should be stored in RAM.
int32_t	skipInterval
	Expert: The fraction of TermDocs entries stored in skip tables, used to accellerate TermDocs#SkipTo(int32_t).

---

Constructor & Destructor Documentation

lucene::index::TermInfosWriter::TermInfosWriter	(	lucene::store::Directory *	directory,
		const char *	segment,
		FieldInfos *	fis,
		int32_t	interval
	)

lucene::index::TermInfosWriter::~TermInfosWriter

(

)

---

Member Function Documentation

void lucene::index::TermInfosWriter::add	(	Term *	term,
		const TermInfo *	ti
	)

Adds a new <Term, TermInfo> pair to the set.

Term must be lexicographically greater than all previous Terms added. TermInfo pointers must be positive and greater than all previous.

void lucene::index::TermInfosWriter::close

(

)

Called to complete TermInfos creation.

lucene::index::TermInfosWriter::LUCENE_STATIC_CONSTANT	(	int32_t	,
		FORMAT	= -2
	)

The file format version, a negative number.

---

Member Data Documentation

int32_t lucene::index::TermInfosWriter::indexInterval

Expert: The fraction of terms in the "dictionary" which should be stored in RAM.

Smaller values use more memory, but make searching slightly faster, while larger values use less memory and make searching slightly slower. Searching is typically not dominated by dictionary lookup, so tweaking this is rarely useful.

int32_t lucene::index::TermInfosWriter::skipInterval

Expert: The fraction of TermDocs entries stored in skip tables, used to accellerate TermDocs#SkipTo(int32_t).

Larger values result in smaller indexes, greater acceleration, but fewer accelerable cases, while smaller values result in bigger indexes, less acceleration and more accelerable cases. More detailed experiments would be useful here.

---

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

• TermInfosWriter.h