Package com.yahoo.searchdefinition.derived

Class DerivedConfiguration

java.lang.Object

com.yahoo.searchdefinition.derived.DerivedConfiguration

All Implemented Interfaces:

com.yahoo.config.ConfigInstance.Producer, com.yahoo.vespa.config.search.AttributesConfig.Producer

public class DerivedConfiguration
extends Object
implements com.yahoo.vespa.config.search.AttributesConfig.Producer

A set of all derived configuration of a search definition. Use this as a facade to individual configurations when necessary.

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
DerivedConfiguration(Schema schema, com.yahoo.config.application.api.DeployLogger deployLogger, com.yahoo.config.model.api.ModelContext.Properties deployProperties, RankProfileRegistry rankProfileRegistry, com.yahoo.search.query.profile.QueryProfileRegistry queryProfiles, ai.vespa.rankingexpression.importer.configmodelview.ImportedMlModels importedModels, ExecutorService executor)	Creates a complete derived configuration snapshot from a search definition.
DerivedConfiguration(Schema schema, RankProfileRegistry rankProfileRegistry)	Creates a complete derived configuration from a search definition.

Method Summary

Modifier and Type	Method	Description
void	export(String toDirectory)	Exports a complete set of configuration-server format config files.
static void	exportDocuments(com.yahoo.document.config.DocumentmanagerConfig.Builder documentManagerCfg, String toDirectory)
static void	exportDocuments(com.yahoo.document.DocumenttypesConfig.Builder documentTypesCfg, String toDirectory)
static void	exportQueryProfiles(com.yahoo.search.query.profile.QueryProfileRegistry queryProfileRegistry, String toDirectory)
AttributeFields	getAttributeFields()
void	getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder)
void	getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder, AttributeFields.FieldSet fs)
ImportedFields	getImportedFields()
IndexInfo	getIndexInfo()
IndexingScript	getIndexingScript()
IndexSchema	getIndexSchema()
Juniperrc	getJuniperrc()
com.yahoo.search.query.profile.QueryProfileRegistry	getQueryProfiles()
RankProfileList	getRankProfileList()
Schema	getSearch()
Summaries	getSummaries()
SummaryMap	getSummaryMap()
VsmFields	getVsmFields()
VsmSummary	getVsmSummary()
void	setIndexingScript(IndexingScript script)

Methods inherited from class java.lang.Object

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

Constructor Detail

DerivedConfiguration

public DerivedConfiguration(Schema schema,
                            RankProfileRegistry rankProfileRegistry)

Creates a complete derived configuration from a search definition. Only used in tests.

Parameters:

schema - the search to derive a configuration from. Derived objects will be snapshots, but this argument is live. Which means that this object will be inconsistent when the given search definition is later modified.

rankProfileRegistry - a RankProfileRegistry

DerivedConfiguration

public DerivedConfiguration(Schema schema,
                            com.yahoo.config.application.api.DeployLogger deployLogger,
                            com.yahoo.config.model.api.ModelContext.Properties deployProperties,
                            RankProfileRegistry rankProfileRegistry,
                            com.yahoo.search.query.profile.QueryProfileRegistry queryProfiles,
                            ai.vespa.rankingexpression.importer.configmodelview.ImportedMlModels importedModels,
                            ExecutorService executor)

Creates a complete derived configuration snapshot from a search definition.

Parameters:

schema - the search to derive a configuration from. Derived objects will be snapshots, but this argument is live. Which means that this object will be inconsistent when the given search definition is later modified.

deployLogger - a DeployLogger for logging when doing operations on this

deployProperties - properties set on deploy

rankProfileRegistry - a RankProfileRegistry

queryProfiles - the query profiles of this application

Method Detail

export

public void export(String toDirectory)
            throws IOException

Exports a complete set of configuration-server format config files.

Parameters:

toDirectory - the directory to export to, current dir if null

Throws:

IOException - if exporting fails, some files may still be created

exportDocuments

public static void exportDocuments(com.yahoo.document.config.DocumentmanagerConfig.Builder documentManagerCfg,
                                   String toDirectory)
                            throws IOException

Throws:

IOException

exportDocuments

public static void exportDocuments(com.yahoo.document.DocumenttypesConfig.Builder documentTypesCfg,
                                   String toDirectory)
                            throws IOException

Throws:

IOException

exportQueryProfiles

public static void exportQueryProfiles(com.yahoo.search.query.profile.QueryProfileRegistry queryProfileRegistry,
                                       String toDirectory)
                                throws IOException

Throws:

IOException

getSummaries

public Summaries getSummaries()

getAttributeFields

public AttributeFields getAttributeFields()

getConfig

public void getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.vespa.config.search.AttributesConfig.Producer

getConfig

public void getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder,
                      AttributeFields.FieldSet fs)

getIndexingScript

public IndexingScript getIndexingScript()

getIndexInfo

public IndexInfo getIndexInfo()

setIndexingScript

public void setIndexingScript(IndexingScript script)

getSearch

public Schema getSearch()

getRankProfileList

public RankProfileList getRankProfileList()

getVsmSummary

public VsmSummary getVsmSummary()

getVsmFields

public VsmFields getVsmFields()

getIndexSchema

public IndexSchema getIndexSchema()

getJuniperrc

public Juniperrc getJuniperrc()

getSummaryMap

public SummaryMap getSummaryMap()

getImportedFields

public ImportedFields getImportedFields()

getQueryProfiles

public com.yahoo.search.query.profile.QueryProfileRegistry getQueryProfiles()