lucene::search::WildcardTermEnum Class Reference

Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term->. More...

#include <WildcardTermEnum.h>

Inheritance diagram for lucene::search::WildcardTermEnum:

Public Member Functions
	WildcardTermEnum (lucene::index::IndexReader *reader, lucene::index::Term *term)
	Creates a new WildcardTermEnum.
	~WildcardTermEnum ()
float_t	difference ()
bool	endEnum ()
void	close ()
const char *	getObjectName ()
	Because we need to know how to cast the object, we need the objects name.
Static Public Member Functions
static bool	wildcardEquals (const TCHAR *pattern, int32_t patternLen, int32_t patternIdx, const TCHAR *str, int32_t strLen, int32_t stringIdx)
	Determines if a word matches a wildcard pattern.
static const char *	getClassName ()
Protected Member Functions
bool	termCompare (lucene::index::Term *term)

---

Detailed Description

Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term->.

Term enumerations are always ordered by term->compareTo(). Each term in the enumeration is greater than all that precede it.

---

Constructor & Destructor Documentation

lucene::search::WildcardTermEnum::WildcardTermEnum	(	lucene::index::IndexReader *	reader,
		lucene::index::Term *	term
	)

Creates a new WildcardTermEnum.

Passing in a Term that does not contain a LUCENE_WILDCARDTERMENUM_WILDCARD_STRING or LUCENE_WILDCARDTERMENUM_WILDCARD_CHAR will cause an exception to be thrown.

lucene::search::WildcardTermEnum::~WildcardTermEnum

(

)

---

Member Function Documentation

bool lucene::search::WildcardTermEnum::termCompare

(

lucene::index::Term *

term

)

[protected, virtual]

Implements lucene::search::FilteredTermEnum.

float_t lucene::search::WildcardTermEnum::difference

(

)

[virtual]

Implements lucene::search::FilteredTermEnum.

bool lucene::search::WildcardTermEnum::endEnum

(

)

[virtual]

Implements lucene::search::FilteredTermEnum.

static bool lucene::search::WildcardTermEnum::wildcardEquals	(	const TCHAR *	pattern,
		int32_t	patternLen,
		int32_t	patternIdx,
		const TCHAR *	str,
		int32_t	strLen,
		int32_t	stringIdx
	)			[static]

Determines if a word matches a wildcard pattern.

void lucene::search::WildcardTermEnum::close

(

)

[virtual]

Reimplemented from lucene::search::FilteredTermEnum.

const char* lucene::search::WildcardTermEnum::getObjectName

(

)

[inline, virtual]

Because we need to know how to cast the object, we need the objects name.

Implements lucene::index::TermEnum.

static const char* lucene::search::WildcardTermEnum::getClassName

(

)

[inline, static]

---

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

• WildcardTermEnum.h