Package com.yahoo.search.grouping

Class GroupingQueryParser

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.component.chain.ChainedComponent

com.yahoo.processing.Processor

com.yahoo.search.Searcher

com.yahoo.search.grouping.GroupingQueryParser

All Implemented Interfaces:

com.yahoo.component.chain.model.Chainable, com.yahoo.component.Component, com.yahoo.component.Deconstructable, Comparable<com.yahoo.component.Component>

public class GroupingQueryParser
extends Searcher

This searcher is responsible for turning the "select" parameter into a corresponding GroupingRequest. It will also parse any "timezone" parameter as the timezone for time expressions such as DayOfMonthFunction and HourOfDayFunction.

Author:

Simon Thoresen Hult

Field Summary

Fields

Modifier and Type	Field	Description
static final com.yahoo.processing.request.CompoundName	GROUPING_GLOBAL_MAX_GROUPS
static final com.yahoo.processing.request.CompoundName	PARAM_CONTINUE
static final com.yahoo.processing.request.CompoundName	PARAM_DEFAULT_MAX_GROUPS
static final com.yahoo.processing.request.CompoundName	PARAM_DEFAULT_MAX_HITS
static final com.yahoo.processing.request.CompoundName	PARAM_DEFAULT_PRECISION_FACTOR
static final com.yahoo.processing.request.CompoundName	PARAM_REQUEST
static final com.yahoo.processing.request.CompoundName	PARAM_TIMEZONE
static final String	SELECT_PARAMETER_PARSING

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor	Description
GroupingQueryParser()

Method Summary

Modifier and Type	Method	Description
static void	createGroupingRequestIn(Query query, GroupingOperation operation, List<Continuation> continuations)
Result	search(Query query, Execution execution)	Override this to implement your searcher.
static void	validate(Query query)

Methods inherited from class com.yahoo.search.Searcher

ensureFilled, fill, getLogger, process, toString

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

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

Methods inherited from interface com.yahoo.component.chain.model.Chainable

getAnnotatedDependencies

Field Details

SELECT_PARAMETER_PARSING

public static final String SELECT_PARAMETER_PARSING

See Also:

• Constant Field Values

PARAM_CONTINUE

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

PARAM_REQUEST

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

PARAM_TIMEZONE

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

PARAM_DEFAULT_MAX_HITS

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

PARAM_DEFAULT_MAX_GROUPS

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

PARAM_DEFAULT_PRECISION_FACTOR

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

GROUPING_GLOBAL_MAX_GROUPS

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

Constructor Details

GroupingQueryParser

public GroupingQueryParser()

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

validate

public static void validate(Query query)

createGroupingRequestIn

public static void createGroupingRequestIn(Query query,
 GroupingOperation operation,
 List<Continuation> continuations)