Class FieldTermStack
FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted.
Inherited Members
Namespace: Lucene.Net.Search.VectorHighlight
Assembly: Lucene.Net.Highlighter.dll
Syntax
public class FieldTermStackConstructors
FieldTermStack(IndexReader, int, string, FieldQuery)
a constructor.
Declaration
public FieldTermStack(IndexReader reader, int docId, string fieldName, FieldQuery fieldQuery)Parameters
| Type | Name | Description |
|---|---|---|
| IndexReader | reader | Lucene.Net.Index.IndexReader of the index |
| int | docId | document id to be highlighted |
| string | fieldName | field of the document to be highlighted |
| FieldQuery | fieldQuery | FieldQuery object |
Exceptions
| Type | Condition |
|---|---|
| IOException | If there is a low-level I/O error |
Properties
FieldName
field name
Declaration
public virtual string FieldName { get; }Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|
| bool |
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(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 |