Package org.codelibs.fess.score

Class ScoreBooster

java.lang.Object
org.codelibs.fess.score.ScoreBooster
public abstract class ScoreBooster extends Object
This class is a base class for score boosters.

  • Field Details

    • bulkRequestBuilder

      protected org.opensearch.action.bulk.BulkRequestBuilder bulkRequestBuilder
      The bulk request builder.

    • priority

      protected int priority
      The priority of this score booster.

    • requestTimeout

      protected String requestTimeout
      The request timeout.

    • requestCacheSize

      protected int requestCacheSize
      The request cache size.

    • scriptLang

      protected String scriptLang
      The script language.

    • scriptCode

      protected String scriptCode
      The script code.

    • idFinder

      protected Function<Map<String,Object>,String[]> idFinder
      A function to find document IDs.

    • requestHandler

      protected Function<Map<String,Object>,Long> requestHandler
      A function to handle requests.

  • Constructor Details

    • ScoreBooster

      public ScoreBooster()
      Constructor.

  • Method Details

    • process

      public abstract long process()
      Processes the score boosting.
      Returns:
      The number of processed documents.

    • enable

      protected void enable()
      Enables this score booster.

    • updateScore

      protected long updateScore(Map<String,Object> params)
      Updates the score of documents.
      Parameters:
      params - The parameters for the update.
      Returns:
      The number of updated documents.

    • createUpdateRequestBuilder

      protected org.opensearch.action.update.UpdateRequestBuilder createUpdateRequestBuilder()
      Creates an update request builder.
      Returns:
      The update request builder.

    • flush

      protected void flush()
      Flushes the bulk request builder.

    • getPriority

      public int getPriority()
      Gets the priority of this score booster.
      Returns:
      The priority.

    • setPriority

      public void setPriority(int priority)
      Sets the priority of this score booster.
      Parameters:
      priority - The priority.

    • setRequestTimeout

      public void setRequestTimeout(String bulkRequestTimeout)
      Sets the request timeout.
      Parameters:
      bulkRequestTimeout - The request timeout.

    • setRequestCacheSize

      public void setRequestCacheSize(int requestCacheSize)
      Sets the request cache size.
      Parameters:
      requestCacheSize - The request cache size.

    • setScriptLang

      public void setScriptLang(String scriptLang)
      Sets the script language.
      Parameters:
      scriptLang - The script language.

    • setScriptCode

      public void setScriptCode(String scriptCode)
      Sets the script code.
      Parameters:
      scriptCode - The script code.