org.apache.lucene.search.vectorhighlight
Class FieldTermStack
java.lang.Object
org.apache.lucene.search.vectorhighlight.FieldTermStack
public class FieldTermStack
- extends Object
FieldTermStack
is a stack that keeps query terms in the specified field
of the document to be highlighted.
Nested Class Summary |
static class |
FieldTermStack.TermInfo
Single term with its position/offsets in the document and IDF weight |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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
getFieldName
public String getFieldName()
- Returns:
- field name
pop
public FieldTermStack.TermInfo pop()
- Returns:
- the top TermInfo object of the stack
push
public void push(FieldTermStack.TermInfo termInfo)
- 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
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.