Package org.opengrok.indexer.search.context

Class ContextFormatter

java.lang.Object
org.apache.lucene.search.uhighlight.PassageFormatter
org.opengrok.indexer.search.context.ContextFormatter
public class ContextFormatter extends org.apache.lucene.search.uhighlight.PassageFormatter
Represents a subclass of PassageFormatter that uses PassageConverter.

  • Constructor Details

    • ContextFormatter

      public ContextFormatter(ContextArgs args)
      Initializes a formatter for the specified arguments.
      Parameters:
      args - required instance

  • Method Details

    • getArgs

      public ContextArgs getArgs()
      Gets the initialized value.
      Returns:
      a defined instance

    • getUrl

      public String getUrl()
      Gets the required URL to use for linking lines.
      Returns:
      the URL or null

    • setUrl

      public void setUrl(String value)
      Sets the required URL to use for linking lines.
      Parameters:
      value - the URL to use

    • getMoreUrl

      public String getMoreUrl()
      Gets the optional URL to use if getMoreLimit() is reached.
      Returns:
      the URL or null

    • setMoreUrl

      public void setMoreUrl(String value)
      Sets the optional URL to use if getMoreLimit() is reached.
      Parameters:
      value - the URL to use

    • getMoreLimit

      public int getMoreLimit()
      Gets the optional line limit to specify (if positive) a maximum number of lines to format and -- if getMoreUrl() is defined -- a "more" link to display. Default is zero (i.e. inactive).
      Returns:
      the line limit value

    • setMoreLimit

      public void setMoreLimit(int value)
      Sets the optional line limit to specify (if positive) a maximum number of lines to format and -- if getMoreUrl() is defined -- a "more" link to display.
      Parameters:
      value - the line limit

    • getDefs

      public Definitions getDefs()
      Gets the optional definitions.
      Returns:
      the defs

    • setDefs

      public void setDefs(Definitions value)
      Sets the optional definitions.
      Parameters:
      value - definitions

    • getScopes

      public Scopes getScopes()
      Gets the optional scopes to use.
      Returns:
      the scopes

    • setScopes

      public void setScopes(Scopes value)
      Sets the optional scopes to use.
      Parameters:
      value - scopes

    • format

      public Object format(org.apache.lucene.search.uhighlight.Passage[] passages, String originalText)
      Splits originalText using SourceSplitter, converts passages using PassageConverter, and formats for presentation in OpenGrok UI using the instance's properties (e.g., getUrl() and getDefs()).
      Specified by:
      format in class org.apache.lucene.search.uhighlight.PassageFormatter
      Parameters:
      passages - a required instance
      originalText - a required instance
      Returns:
      a defined FormattedLines instance, which might be empty
      Throws:
      IllegalStateException - if getUrl() is null