Xapian::ValueCountMatchSpy Class Reference

Class for counting the frequencies of values in the matching documents. More...

#include <matchspy.h>

Inheritance diagram for Xapian::ValueCountMatchSpy:

Collaboration diagram for Xapian::ValueCountMatchSpy:

List of all members.

Classes

struct Internal

Public Member Functions

ValueCountMatchSpy ()

Construct an empty ValueCountMatchSpy.

ValueCountMatchSpy (Xapian::valueno slot_)

Construct a MatchSpy which counts the values in a particular slot.

size_t get_total () const

Return the total number of documents tallied.

TermIterator values_begin () const

Get an iterator over the values seen in the slot.

TermIterator values_end () const

End iterator corresponding to values_begin().

TermIterator top_values_begin (size_t maxvalues) const

Get an iterator over the most frequent values seen in the slot.

TermIterator top_values_end (size_t) const

End iterator corresponding to top_values_begin().

void operator() (const Xapian::Document &doc, Xapian::weight wt)

Implementation of virtual operator().

virtual MatchSpy * clone () const

Clone the match spy.

virtual std::string name () const

Return the name of this match spy.

virtual std::string serialise () const

Return this object's parameters serialised as a single string.

virtual MatchSpy * unserialise (const std::string &s, const Registry &context) const

Unserialise parameters.

virtual std::string serialise_results () const

Serialise the results of this match spy.

virtual void merge_results (const std::string &s)

Unserialise some results, and merge them into this matchspy.

virtual std::string get_description () const

Return a string describing this object.

Protected Attributes

Xapian::Internal::RefCntPtr
< Internal > internal

Detailed Description

Class for counting the frequencies of values in the matching documents.

Definition at line 180 of file matchspy.h.

Constructor & Destructor Documentation

Xapian::ValueCountMatchSpy::ValueCountMatchSpy ( ) [inline]

Construct an empty ValueCountMatchSpy.

Definition at line 207 of file matchspy.h.

Referenced by clone(), and unserialise().

Xapian::ValueCountMatchSpy::ValueCountMatchSpy ( Xapian::valueno slot_ ) [inline]

Construct a MatchSpy which counts the values in a particular slot.

Definition at line 210 of file matchspy.h.

Member Function Documentation

MatchSpy * ValueCountMatchSpy::clone ( ) const [virtual]

Clone the match spy.

The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be passed information about the results seen by the parent.

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: http://trac.xapian.org/ticket/554#comment:1

Reimplemented from Xapian::MatchSpy.

Definition at line 321 of file matchspy.cc.

References internal, and ValueCountMatchSpy().

string ValueCountMatchSpy::get_description ( ) const [virtual]

Return a string describing this object.

This default implementation returns a generic answer, to avoid forcing those deriving their own MatchSpy subclasses from having to implement this (they may not care what get_description() gives for their subclass).

Reimplemented from Xapian::MatchSpy.

Definition at line 388 of file matchspy.cc.

References internal, and Xapian::Internal::str().

Referenced by DEFINE_TESTCASE().

size_t Xapian::ValueCountMatchSpy::get_total ( ) const [inline]

Return the total number of documents tallied.

Definition at line 214 of file matchspy.h.

Referenced by DEFINE_TESTCASE().

void ValueCountMatchSpy::merge_results ( const std::string & s ) [virtual]

Unserialise some results, and merge them into this matchspy.

The order in which results are merged should not be significant, since this order is not specified (and will vary depending on the speed of the search in each sub-database).

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Parameters:

s

A string containing the serialised results.

Reimplemented from Xapian::MatchSpy.

Definition at line 367 of file matchspy.cc.

References decode_length(), and LOGCALL_VOID.

string ValueCountMatchSpy::name ( ) const [virtual]

Return the name of this match spy.

This name is used by the remote backend. It is passed with the serialised parameters to the remote server so that it knows which class to create.

Return the full namespace-qualified name of your class here - if your class is called MyApp::FooMatchSpy, return "MyApp::FooMatchSpy" from this method.

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Reimplemented from Xapian::MatchSpy.

Definition at line 326 of file matchspy.cc.

void ValueCountMatchSpy::operator()	(	const Xapian::Document &	doc,
		Xapian::weight	wt
	)			`[virtual]`

Implementation of virtual operator().

This implementation tallies values for a matching document.

Parameters:

	doc	The document to tally values for.
	wt	The weight of the document (ignored by this class).

Implements Xapian::MatchSpy.

Definition at line 298 of file matchspy.cc.

References Xapian::Document::get_value(), and internal.

string ValueCountMatchSpy::serialise ( ) const [virtual]

Return this object's parameters serialised as a single string.

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Reimplemented from Xapian::MatchSpy.

Definition at line 331 of file matchspy.cc.

References encode_length(), and internal.

string ValueCountMatchSpy::serialise_results ( ) const [virtual]

Serialise the results of this match spy.

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Reimplemented from Xapian::MatchSpy.

Definition at line 352 of file matchspy.cc.

References encode_length(), internal, LOGCALL, and RETURN.

TermIterator ValueCountMatchSpy::top_values_begin ( size_t maxvalues ) const

Get an iterator over the most frequent values seen in the slot.

Items will be returned in descending order of frequency. Values with the same frequency will be returned in ascending alphabetical order.

During the iteration, the frequency of the current value can be obtained with the get_termfreq() method on the iterator.

Parameters:

maxvalues

The maximum number of values to return.

Definition at line 312 of file matchspy.cc.

References get_most_frequent_items(), and internal.

Referenced by DEFINE_TESTCASE().

TermIterator Xapian::ValueCountMatchSpy::top_values_end ( size_t ) const [inline]

End iterator corresponding to top_values_begin().

Definition at line 245 of file matchspy.h.

Referenced by DEFINE_TESTCASE().

MatchSpy * ValueCountMatchSpy::unserialise	(	const std::string &	s,
		const Registry &	context
	)			const `[virtual]`

Unserialise parameters.

This method unserialises parameters serialised by the serialise() method and allocates and returns a new object initialised with them.

If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: http://trac.xapian.org/ticket/554#comment:1

Parameters:

	s	A string containing the serialised results.
	context	Registry object to use for unserialisation to permit MatchSpy subclasses with sub-MatchSpy objects to be implemented.

Reimplemented from Xapian::MatchSpy.

Definition at line 338 of file matchspy.cc.

References decode_length(), and ValueCountMatchSpy().

TermIterator ValueCountMatchSpy::values_begin ( ) const

Get an iterator over the values seen in the slot.

Items will be returned in ascending alphabetical order.

During the iteration, the frequency of the current value can be obtained with the get_termfreq() method on the iterator.

Definition at line 305 of file matchspy.cc.

Referenced by DEFINE_TESTCASE(), and values_to_repr().

TermIterator Xapian::ValueCountMatchSpy::values_end ( ) const [inline]

End iterator corresponding to values_begin().

Definition at line 228 of file matchspy.h.

Referenced by DEFINE_TESTCASE(), and values_to_repr().

Member Data Documentation

Xapian::Internal::RefCntPtr<Internal> Xapian::ValueCountMatchSpy::internal [protected]

Definition at line 203 of file matchspy.h.

Referenced by clone(), get_description(), operator()(), serialise(), serialise_results(), and top_values_begin().

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

include/xapian/matchspy.h
api/matchspy.cc


Classes
struct	Internal
Public Member Functions
	ValueCountMatchSpy ()
	Construct an empty ValueCountMatchSpy.
	ValueCountMatchSpy (Xapian::valueno slot_)
	Construct a MatchSpy which counts the values in a particular slot.
size_t	get_total () const
	Return the total number of documents tallied.
TermIterator	values_begin () const
	Get an iterator over the values seen in the slot.
TermIterator	values_end () const
	End iterator corresponding to values_begin().
TermIterator	top_values_begin (size_t maxvalues) const
	Get an iterator over the most frequent values seen in the slot.
TermIterator	top_values_end (size_t) const
	End iterator corresponding to top_values_begin().
void	operator() (const Xapian::Document &doc, Xapian::weight wt)
	Implementation of virtual operator().
virtual MatchSpy *	clone () const
	Clone the match spy.
virtual std::string	name () const
	Return the name of this match spy.
virtual std::string	serialise () const
	Return this object's parameters serialised as a single string.
virtual MatchSpy *	unserialise (const std::string &s, const Registry &context) const
	Unserialise parameters.
virtual std::string	serialise_results () const
	Serialise the results of this match spy.
virtual void	merge_results (const std::string &s)
	Unserialise some results, and merge them into this matchspy.
virtual std::string	get_description () const
	Return a string describing this object.
Protected Attributes
Xapian::Internal::RefCntPtr < Internal >	internal