Class FieldTermStack

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

Inheritance
System.Object
FieldTermStack
Namespace: Lucene.Net.Search.VectorHighlight
Assembly: Lucene.Net.Highlighter.dll
Syntax
public class FieldTermStack : object

Constructors

| Improve this Doc View Source

FieldTermStack(IndexReader, Int32, String, FieldQuery)

a constructor.

Declaration
public FieldTermStack(IndexReader reader, int docId, string fieldName, FieldQuery fieldQuery)
Parameters
Type Name Description
IndexReader reader

of the index
System.Int32 docId

document id to be highlighted
System.String fieldName

field of the document to be highlighted
FieldQuery fieldQuery

FieldQuery object

Properties

| Improve this Doc View Source

FieldName

field name

Declaration
public virtual string FieldName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsEmpty

to know whether the stack is empty. Returns true if the stack is empty, false if not

Declaration
public virtual bool IsEmpty { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

Pop()

Returns the top FieldTermStack.TermInfo object of the stack

Declaration
public virtual FieldTermStack.TermInfo Pop()
Returns
Type Description
FieldTermStack.TermInfo

the top FieldTermStack.TermInfo object of the stack
| Improve this Doc View Source

Push(FieldTermStack.TermInfo)

Puts a FieldTermStack.TermInfo onto the top of the stack

Declaration
public virtual void Push(FieldTermStack.TermInfo termInfo)
Parameters
Type Name Description
FieldTermStack.TermInfo termInfo

the FieldTermStack.TermInfo object to be put on the top of the stack