Class FieldTermStack
java.lang.Object
org.apache.lucene.search.vectorhighlight.FieldTermStack
FieldTermStack
is a stack that keeps query terms in the specified field of the
document to be highlighted.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Single term with its position/offsets in the document and IDF weight. -
Constructor Summary
ConstructorDescriptionFieldTermStack
(IndexReader reader, int docId, String fieldName, FieldQuery fieldQuery) a constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
isEmpty()
to know whether the stack is emptypop()
void
push
(FieldTermStack.TermInfo termInfo)
-
Constructor Details
-
FieldTermStack
public FieldTermStack(IndexReader reader, int docId, String fieldName, FieldQuery fieldQuery) throws IOException a constructor.- Parameters:
reader
- IndexReader of the indexdocId
- document id to be highlightedfieldName
- field of the document to be highlightedfieldQuery
- FieldQuery object- Throws:
IOException
- If there is a low-level I/O error
-
-
Method Details
-
getFieldName
- Returns:
- field name
-
pop
- Returns:
- the top TermInfo object of the stack
-
push
- Parameters:
termInfo
- the TermInfo object to be put on the top of the stack
-
isEmpty
public boolean isEmpty()to know whether the stack is empty- Returns:
- true if the stack is empty, false if not
-