Package com.yahoo.search.grouping

Class GroupingValidator

java.lang.Object
com.yahoo.component.AbstractComponent
com.yahoo.component.chain.ChainedComponent
com.yahoo.processing.Processor
com.yahoo.search.Searcher
com.yahoo.search.grouping.GroupingValidator
All Implemented Interfaces:
com.yahoo.component.Component, com.yahoo.component.Deconstructable, Comparable<com.yahoo.component.Component>
public class GroupingValidator extends Searcher
This searcher ensure that all GroupingRequest objects attached to a Query makes sense to the search cluster for which this searcher has been deployed. This searcher uses exceptions to signal invalid grouping requests.
Author:
Simon Thoresen Hult

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    GROUPING_VALIDATED
     
    static final com.yahoo.processing.request.CompoundName
    PARAM_ENABLED
     

    Fields inherited from class com.yahoo.component.AbstractComponent

    isDeconstructable

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroupingValidator(com.yahoo.container.QrSearchersConfig qrsConfig, ClusterConfig clusterConfig, com.yahoo.vespa.config.search.AttributesConfig attributesConfig)
    Constructs a new instance of this searcher with the given component id and config.

  • Method Summary

    Modifier and Type
    Method
    Description
    Result
    search(Query query, Execution execution)
    Override this to implement your searcher.

    Methods inherited from class com.yahoo.search.Searcher

    ensureFilled, fill, getLogger, process, toString

    Methods inherited from class com.yahoo.component.chain.ChainedComponent

    getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies

    Methods inherited from class com.yahoo.component.AbstractComponent

    clone, compareTo, deconstruct, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable

    Methods inherited from class java.lang.Object

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

  • Field Details

    • GROUPING_VALIDATED

      public static final String GROUPING_VALIDATED
      See Also:

    • PARAM_ENABLED

      public static final com.yahoo.processing.request.CompoundName PARAM_ENABLED

  • Constructor Details

    • GroupingValidator

      @Inject public GroupingValidator(com.yahoo.container.QrSearchersConfig qrsConfig, ClusterConfig clusterConfig, com.yahoo.vespa.config.search.AttributesConfig attributesConfig)
      Constructs a new instance of this searcher with the given component id and config.
      Parameters:
      qrsConfig - The shared config for all searchers.
      clusterConfig - The config for the cluster that this searcher is deployed for.

  • Method Details

    • search

      public Result search(Query query, Execution execution)
      Description copied from class: Searcher
      Override this to implement your searcher.

      Searcher implementation subclasses will, depending on their type of logic, do one of the following:

      • Query processors: Access the query, then call execution.search and return the result
      • Result processors: Call execution.search to get the result, access it and return
      • Sources (which produces results): Create a result, add the desired hits and return it.
      • Federators (which forwards the search to multiple subchains): Call search on the desired subchains in parallel and get the results. Combine the results to one and return it.
      • Workflows: Call execution.search as many times as desired, using different queries. Eventually return a result.

      Hits come in two kinds - concrete hits are actual content of the kind requested by the user, meta hits are hits which provides information about the collection of hits, on the query, the service and so on.

      The query specifies a window into a larger result list that must be returned from the searcher through hits and offset; Searchers which returns list of hits in the top level in the result must return at least hits number of hits (or if impossible; all that are available), starting at the given offset. In addition, searchers are allowed to return any number of meta hits (although this number is expected to be low). For hits contained in nested hit groups, the concept of a window defined by hits and offset is not well defined and does not apply.

      Error handling in searchers:

      • Unexpected events: Throw any RuntimeException. This query will fail with the exception message, and the error will be logged
      • Expected events: Create (new Result(Query, ErrorMessage) or add result.setErrorIfNoOtherErrors(ErrorMessage) an error message to the Result.
      • Recoverable user errors: Add a FeedbackHit explaining the condition and how to correct it.
      Specified by:
      search in class Searcher
      Parameters:
      query - the query
      Returns:
      the result of making this query