Package com.yahoo.searchdefinition.processing

Class ImplicitSummaryFields

java.lang.Object

com.yahoo.searchdefinition.processing.Processor

com.yahoo.searchdefinition.processing.ImplicitSummaryFields

public class ImplicitSummaryFields
extends Processor

This processor adds all implicit summary fields to all registered document summaries. If another field has already been registered with one of the implicit names, this processor will throw an IllegalStateException.

Field Summary

Fields inherited from class com.yahoo.searchdefinition.processing.Processor

deployLogger, queryProfiles, rankProfileRegistry, schema

Constructor Summary

Constructors

Constructor	Description
ImplicitSummaryFields(Schema schema, com.yahoo.config.application.api.DeployLogger deployLogger, RankProfileRegistry rankProfileRegistry, QueryProfiles queryProfiles)

Method Summary

Modifier and Type	Method	Description
void	process(boolean validate, boolean documentsOnly)	Processes the input search definition by modifying the input search and its documents, and returns the input search definition.

Methods inherited from class com.yahoo.searchdefinition.processing.Processor

addField, fail, formatError, info, info, matchingRankSettingsIterator, newProcessException, newProcessException, process, warn, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

ImplicitSummaryFields

public ImplicitSummaryFields(Schema schema,
                             com.yahoo.config.application.api.DeployLogger deployLogger,
                             RankProfileRegistry rankProfileRegistry,
                             QueryProfiles queryProfiles)

Method Detail

process

public void process(boolean validate,
                    boolean documentsOnly)

Description copied from class: Processor

Processes the input search definition by modifying the input search and its documents, and returns the input search definition.

Specified by:

process in class Processor

Parameters:

validate - true to throw exceptions on validation errors, false to make the best possible effort at completing processing without throwing an exception. If we are not validating, emitting warnings have no effect and can (but must not) be skipped.

documentsOnly - true to skip processing (including validation, regardless of the validate setting) of aspects not relating to document definitions (e.g rank profiles)