Package com.yahoo.prelude.fastsearch

Class PartialSummaryHandler

java.lang.Object
com.yahoo.prelude.fastsearch.PartialSummaryHandler
public class PartialSummaryHandler extends Object
PartialSummaryHandler is a helper class to help handling of fill() requests which only cover some of the possible summary fields. Usage: 1) construct from DocumentDatabase or DocsumDefinitionSet 2) call wantToFill to specify intent 3) use askForSummary and askForFields for making the backend request 4) use needFill to see if the Hit actually needs filling 5) use effectiveDocsumDef for decoding the backend response 6) use markFilled to mark the Hit with what actually got filled
Author:
arnej

  • Field Details

  • Constructor Details

    • PartialSummaryHandler

      public PartialSummaryHandler(DocumentDatabase docDb)

    • PartialSummaryHandler

      public PartialSummaryHandler(DocsumDefinitionSet docsumDefinitionSet)

    • PartialSummaryHandler

      public PartialSummaryHandler(Map<String,Set<String>> knownSummaryClasses)

  • Method Details

    • resolveSummaryClass

      public static String resolveSummaryClass(Result result)
      resolve summary class to use when none provided

    • wantToFill

      public void wantToFill(Result result, String summaryClass)

    • wantToFill

      public void wantToFill(Query query)

    • askForSummary

      public String askForSummary()

    • askForFields

      public Set<String> askForFields()

    • needFill

      public boolean needFill(Hit hit)

    • resultAlreadyFilled

      public boolean resultAlreadyFilled()

    • effectiveDocsumDef

      public DocsumDefinition effectiveDocsumDef()

    • markFilled

      public void markFilled(Hit hit)

    • quotedSummaryClassName

      public static String quotedSummaryClassName(String summaryClass, Set<String> summaryFields)

    • enoughFields

      public static String enoughFields(String summaryClass, Result result)

    • validateSummaryClass

      public void validateSummaryClass(String summaryClass, Query query)