Class FieldTermStack

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

Inheritance

System.Object

FieldTermStack

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Search.VectorHighlight

Assembly: Lucene.Net.Highlighter.dll

Syntax

public class FieldTermStack

Constructors

FieldTermStack(IndexReader, Int32, String, FieldQuery)

a constructor.

Declaration

public FieldTermStack(IndexReader reader, int docId, string fieldName, FieldQuery fieldQuery)

Parameters

Type	Name	Description
Lucene.Net.Index.IndexReader	reader	Lucene.Net.Index.IndexReader 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

Exceptions

Type	Condition
System.IO.IOException	If there is a low-level I/O error

Properties

FieldName

field name

Declaration

public virtual string FieldName { get; }

Property Value

Type	Description
System.String

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

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

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