Lucene.Net.Search.WildcardTermEnum Class Reference

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. More...

Inherits Lucene.Net.Search.FilteredTermEnum.

Public Member Functions
	WildcardTermEnum (IndexReader reader, Term term)
	Creates a new WildcardTermEnum. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.
override float	Difference ()
	Equality measure on the term
override bool	EndEnum ()
	Indicates the end of the enumeration has been reached
Public Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
override int	DocFreq ()
	Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
override bool	Next ()
	Increments the enumeration to the next element. True if one exists.

Static Public Member Functions
static bool	WildcardEquals (System.String pattern, int patternIdx, System.String string_Renamed, int stringIdx)
	Determines if a word matches a wildcard pattern. Work released by Granta Design Ltd after originally being done on company time.

Public Attributes
const char	WILDCARD_STRING = '*'
	***************************************** String equality with support for wildcards
const char	WILDCARD_CHAR = '?'

Additional Inherited Members
Protected Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
	FilteredTermEnum ()
override void	Dispose (bool disposing)
Properties inherited from Lucene.Net.Search.FilteredTermEnum
override Term	Term [get]
	Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.

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.

Definition at line 32 of file WildcardTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.WildcardTermEnum.WildcardTermEnum	(	IndexReader	reader,
		Term	term
	)

Creates a new WildcardTermEnum. After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Definition at line 46 of file WildcardTermEnum.cs.

Member Function Documentation

override float Lucene.Net.Search.WildcardTermEnum.Difference ( )

virtual

Equality measure on the term

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 84 of file WildcardTermEnum.cs.

override bool Lucene.Net.Search.WildcardTermEnum.EndEnum ( )

virtual

Indicates the end of the enumeration has been reached

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 89 of file WildcardTermEnum.cs.

static bool Lucene.Net.Search.WildcardTermEnum.WildcardEquals ( System.String  pattern, int  patternIdx, System.String  string_Renamed, int  stringIdx  )

static

Determines if a word matches a wildcard pattern. Work released by Granta Design Ltd after originally being done on company time.

Definition at line 106 of file WildcardTermEnum.cs.

Member Data Documentation

const char Lucene.Net.Search.WildcardTermEnum.WILDCARD_CHAR = '?'

Definition at line 100 of file WildcardTermEnum.cs.

const char Lucene.Net.Search.WildcardTermEnum.WILDCARD_STRING = '*'

***************************************** String equality with support for wildcards

---

Definition at line 99 of file WildcardTermEnum.cs.

---

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

• core/Search/WildcardTermEnum.cs