Package org.opengrok.indexer.search.context

Class Context

java.lang.Object
org.opengrok.indexer.search.context.Context
public class Context extends Object
This is supposed to get the matching lines from sourcefile. since Lucene does not easily give the match context.

  • Constructor Details

    • Context

      public Context(org.apache.lucene.search.Query query, QueryBuilder qbuilder)
      Initializes a context generator for matchers derived from the specified query -- which might be null and result in isEmpty() returning true.
      Parameters:
      query - the query to generate the result for
      qbuilder - required builder used to create query

  • Method Details

    • toggleAlt

      public void toggleAlt()
      Toggles the alternating value (initially true).

    • isEmpty

      public boolean isEmpty()

    • getContext2

      public boolean getContext2(RuntimeEnvironment env, org.apache.lucene.search.IndexSearcher searcher, int docId, Appendable dest, String urlPrefix, String morePrefix, boolean limit, int tabSize)
      Look for context for this instance's initialized query in a search result Document, and output according to the parameters.
      Parameters:
      env - required environment
      searcher - required search that produced the document
      docId - document ID for producing context
      dest - required target to write
      urlPrefix - prefix for links
      morePrefix - optional link to more... page
      limit - a value indicating if the number of matching lines should be limited. N.b. unlike getContext(java.io.Reader, java.io.Writer, java.lang.String, java.lang.String, java.lang.String, org.opengrok.indexer.analysis.Definitions, boolean, boolean, java.util.List, org.opengrok.indexer.analysis.Scopes), the limit argument will not be interpreted w.r.t. RuntimeEnvironment.isQuickContextScan().
      tabSize - optional positive tab size that must accord with the value used when indexing or else postings may be wrongly shifted until re-indexing
      Returns:
      Did it get any matching context?

    • getContext

      public boolean getContext(Reader in, Writer out, String urlPrefix, String morePrefix, String path, Definitions tags, boolean limit, boolean isDefSearch, List<Hit> hits)

    • getContext

      public boolean getContext(Reader in, Writer out, String urlPrefix, String morePrefix, String path, Definitions tags, boolean limit, boolean isDefSearch, List<Hit> hits, Scopes scopes)
      ???. Closes the given in reader on return.
      Parameters:
      in - File to be matched
      out - to write the context
      urlPrefix - URL prefix
      morePrefix - to link to more... page
      path - path of the file
      tags - format to highlight defs.
      limit - should the number of matching lines be limited?
      isDefSearch - is definition search
      hits - list of hits
      scopes - scopes object
      Returns:
      Did it get any matching context?