Package org.opengrok.indexer.search.context

Class ContextArgs

java.lang.Object
org.opengrok.indexer.search.context.ContextArgs
public class ContextArgs extends Object
Represents an immutable settings instance for coordinating objects related to producing context presentations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContextArgs(short contextSurround, short contextLimit)
    Initializes an instance with the specified values.

  • Method Summary

    Modifier and Type
    Method
    Description
    short
    getContextLimit()
    Gets the maximum number of lines to present, after which a "more..." link is displayed to allow the user to view full match results.
    short
    getContextSurround()
    Gets the number of lines of leading and trailing context surrounding each match line to present.
    int
    getContextWidth()
    Gets a value indicating the maximum width to show for lines in a context presentation.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ContextArgs

      public ContextArgs(short contextSurround, short contextLimit)
      Initializes an instance with the specified values.

      short is used because some Lucene classes were found to choke when OpenGrok used Integer.MAX_VALUE to mean "unbounded". short is safer therefore but unfortunately somewhat syntactically inconvenient.

      Parameters:
      contextSurround - a non-negative value
      contextLimit - a positive value

  • Method Details

    • getContextSurround

      public short getContextSurround()
      Gets the number of lines of leading and trailing context surrounding each match line to present.

      (N.b. the value is used w.r.t. getContextLimit() and therefore w.r.t. Lucene uhighlight, and short is safer, though syntactically inconvenient, to avoid numeric overlow that may occur with int in that library.)

      Returns:
      a non-negative value

    • getContextLimit

      public short getContextLimit()
      Gets the maximum number of lines to present, after which a "more..." link is displayed to allow the user to view full match results.

      (N.b. the value is used with Lucene uhighlight, and short is safer, though syntactically inconvenient, to avoid numeric overflow that may occur with int in that library.)

      Returns:
      a positive value

    • getContextWidth

      public int getContextWidth()
      Gets a value indicating the maximum width to show for lines in a context presentation.
      Returns:
      a positive value