Class FieldTermStack


  • public class FieldTermStack
    extends java.lang.Object
    FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted.
    • Constructor Detail

      • FieldTermStack

        public FieldTermStack​(IndexReader reader,
                              int docId,
                              java.lang.String fieldName,
                              FieldQuery fieldQuery)
                       throws java.io.IOException
        a constructor.
        Parameters:
        reader - IndexReader of the index
        docId - document id to be highlighted
        fieldName - field of the document to be highlighted
        fieldQuery - FieldQuery object
        Throws:
        java.io.IOException - If there is a low-level I/O error
    • Method Detail

      • getFieldName

        public java.lang.String getFieldName()
        Returns:
        field name
      • 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