JASS::serialise_forward_index Class Reference

Serialse an index into a forward index in XML. More...

#include <serialise_forward_index.h>

Inheritance diagram for JASS::serialise_forward_index:

Collaboration diagram for JASS::serialise_forward_index:

Public Member Functions
	serialise_forward_index (size_t documents)
	Constructor. More...
	~serialise_forward_index ()
void	finish (void)
virtual void	operator() (const slice &term, const index_postings &postings, compress_integer::integer document_frequency, compress_integer::integer *document_ids, index_postings_impact::impact_type *term_frequencies)
	The callback function to serialise the postings (given the term) is operator(). More...
virtual void	operator() (size_t document_id, const slice &primary_key)
	The callback function to serialise the primary keys (external document ids) is operator(). More...
Public Member Functions inherited from JASS::index_manager::delegate
	delegate (size_t documents)
	Destructor.
virtual	~delegate ()
	Destructor.

Static Public Member Functions
static void	unittest (void)
	Unit test this class.

Private Attributes
std::vector< std::ostringstream >	document
	Each document is represented as a string.

Additional Inherited Members
Public Attributes inherited from JASS::index_manager::delegate
size_t	documents
	The number of documents in the collection.

Detailed Description

Serialse an index into a forward index in XML.

Constructor & Destructor Documentation

serialise_forward_index()

JASS::serialise_forward_index::serialise_forward_index

(

size_t

documents

)

Constructor.

Parameters

documents

[in] The numner of socuments in the collection.

~serialise_forward_index()

JASS::serialise_forward_index::~serialise_forward_index ( )

inline

Destructor

Member Function Documentation

finish()

void JASS::serialise_forward_index::finish ( void  )

virtual

Do any final cleaning up

Implements JASS::index_manager::delegate.

operator()() [1/2]

void JASS::serialise_forward_index::operator() ( const slice &  term, const index_postings &  postings, compress_integer::integer  document_frequency, compress_integer::integer *  document_ids, index_postings_impact::impact_type *  term_frequencies  )

virtual

The callback function to serialise the postings (given the term) is operator().

Parameters

term	[in] The term name.
postings	[in] The postings lists.
document_frequency	[in] The document frequency of the term
document_ids	[in] An array (of length document_frequency) of document ids.
term_frequencies	[in] An array (of length document_frequency) of term frequencies (corresponding to document_ids).

Implements JASS::index_manager::delegate.

operator()() [2/2]

void JASS::serialise_forward_index::operator() ( size_t  document_id, const slice &  primary_key  )

virtual

The callback function to serialise the primary keys (external document ids) is operator().

Parameters

document_id	[in] The internal document identfier.
primary_key	[in] This document's primary key (external document identifier).

Implements JASS::index_manager::delegate.

---

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

• source/serialise_forward_index.h
• source/serialise_forward_index.cpp