Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
Lucene.Net.Search.Vectorhighlight.FieldTermStack Class Reference

FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted. More...

Classes

class  TermInfo
 

Public Member Functions

 FieldTermStack (IndexReader reader, int docId, String fieldName, FieldQuery fieldQuery)
 a constructor.
 
TermInfo Pop ()
 
 
void Push (TermInfo termInfo)
 
 
bool IsEmpty ()
 to know whether the stack is empty
 

Static Public Member Functions

static void Main (String[] args)
 

Public Attributes

LinkedList< TermInfotermList = new LinkedList<TermInfo>()
 

Properties

string FieldName [get]
 
 

Detailed Description

FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted.

Definition at line 37 of file FieldTermStack.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Vectorhighlight.FieldTermStack.FieldTermStack ( IndexReader  reader,
int  docId,
String  fieldName,
FieldQuery  fieldQuery 
)

a constructor.

Parameters
readerIndexReader of the index
docIddocument id to be highlighted
fieldNamefield of the document to be highlighted
fieldQueryFieldQuery object

Definition at line 102 of file FieldTermStack.cs.

Member Function Documentation

bool Lucene.Net.Search.Vectorhighlight.FieldTermStack.IsEmpty ( )

to know whether the stack is empty

Returns
true if the stack is empty, false if not

Definition at line 191 of file FieldTermStack.cs.

static void Lucene.Net.Search.Vectorhighlight.FieldTermStack.Main ( String[]  args)
static

Definition at line 42 of file FieldTermStack.cs.

TermInfo Lucene.Net.Search.Vectorhighlight.FieldTermStack.Pop ( )

Returns
the top TermInfo object of the stack

Definition at line 168 of file FieldTermStack.cs.

void Lucene.Net.Search.Vectorhighlight.FieldTermStack.Push ( TermInfo  termInfo)

Parameters
termInfothe TermInfo object to be put on the top of the stack

Definition at line 181 of file FieldTermStack.cs.

Member Data Documentation

LinkedList<TermInfo> Lucene.Net.Search.Vectorhighlight.FieldTermStack.termList = new LinkedList<TermInfo>()

Definition at line 40 of file FieldTermStack.cs.

Property Documentation

string Lucene.Net.Search.Vectorhighlight.FieldTermStack.FieldName
get

field name

Definition at line 160 of file FieldTermStack.cs.


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