lucene::search::ScoreDocComparators::String Class Reference

#include <Compare.h>

Inheritance diagram for lucene::search::ScoreDocComparators::String:

Public Member Functions
	String (FieldCache::StringIndex *index, int32_t len)
int32_t	compare (struct ScoreDoc *i, struct ScoreDoc *j)
	Compares two ScoreDoc objects and returns a result indicating their sort order.
lucene::util::Comparable *	sortValue (struct ScoreDoc *i)
	Returns the value used to sort the given document.
int32_t	sortType ()
	Returns the type of sort.

---

Constructor & Destructor Documentation

lucene::search::ScoreDocComparators::String::String	(	FieldCache::StringIndex *	index,
		int32_t	len
	)

---

Member Function Documentation

int32_t lucene::search::ScoreDocComparators::String::compare	(	struct ScoreDoc *	i,
		struct ScoreDoc *	j
	)			[virtual]

Compares two ScoreDoc objects and returns a result indicating their sort order.

Parameters:

	i	First ScoreDoc
	j	Second ScoreDoc

Returns:

-1 if i should come before j
1 if i should come after j
0 if they are equal

See also:

java.util.Comparator

Implements lucene::search::ScoreDocComparator.

lucene:: util ::Comparable* lucene::search::ScoreDocComparators::String::sortValue

(

struct ScoreDoc *

i

)

[virtual]

Returns the value used to sort the given document.

The object returned must implement the java.io.Serializable interface. This is used by multisearchers to determine how to collate results from their searchers.

See also:

FieldDoc

Parameters:

i

Document

Returns:

Serializable object

Implements lucene::search::ScoreDocComparator.

int32_t lucene::search::ScoreDocComparators::String::sortType

(

)

[virtual]

Returns the type of sort.

Should return SortField.SCORE, SortField.DOC, SortField.STRING, SortField.INTEGER, SortField::FLOAT or SortField.CUSTOM. It is not valid to return SortField.AUTO. This is used by multisearchers to determine how to collate results from their searchers.

Returns:

One of the constants in SortField.

See also:

SortField

Implements lucene::search::ScoreDocComparator.

---

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

• Compare.h