Package com.yahoo.search.query.profile

Class QueryProfileProperties

java.lang.Object

com.yahoo.processing.request.Properties

com.yahoo.search.query.Properties

com.yahoo.search.query.profile.QueryProfileProperties

All Implemented Interfaces:

Cloneable

public class QueryProfileProperties
extends Properties

Properties backed by a query profile. This has the scope of one query and is not multithread safe.

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
QueryProfileProperties(CompiledQueryProfile profile)
QueryProfileProperties(CompiledQueryProfile profile, com.yahoo.language.process.Embedder embedder)	Deprecated.
QueryProfileProperties(CompiledQueryProfile profile, Map<String,com.yahoo.language.process.Embedder> embedders)	Deprecated.
QueryProfileProperties(CompiledQueryProfile profile, Map<String,com.yahoo.language.process.Embedder> embedders, ai.vespa.cloud.ZoneInfo zoneInfo)	Creates an instance from a profile, throws an exception if the given profile is null

Method Summary

Modifier and Type	Method	Description
void	clearAll(com.yahoo.processing.request.CompoundName name, Map<String,String> context)
QueryProfileProperties	clone()
Object	get(com.yahoo.processing.request.CompoundName name, Map<String,String> context, com.yahoo.processing.request.Properties substitution)	Gets a value from the query profile, or from the nested profile if the value is null
CompiledQueryProfile	getQueryProfile()	Returns the query profile backing this, or null if none
boolean	isComplete(StringBuilder firstMissingName, Map<String,String> context)
Map<String,Object>	listProperties(com.yahoo.processing.request.CompoundName path, Map<String,String> context, com.yahoo.processing.request.Properties substitution)
void	requireSettable(com.yahoo.processing.request.CompoundName name, Object value, Map<String,String> context)	Throws IllegalInputException if the given key cannot be set to the given value.
void	set(com.yahoo.processing.request.CompoundName name, Object value, Map<String,String> context)	Sets a value in this query profile

Methods inherited from class com.yahoo.search.query.Properties

chained, getParentQuery, setParentQuery

Methods inherited from class com.yahoo.processing.request.Properties

asBoolean, asDouble, asInteger, asLong, asString, chain, clearAll, clearAll, clearAll, clone, cloneMap, get, get, get, get, get, get, get, getBoolean, getBoolean, getBoolean, getBoolean, getDouble, getDouble, getDouble, getDouble, getInstance, getInteger, getInteger, getInteger, getInteger, getLong, getLong, getLong, getLong, getString, getString, getString, getString, listProperties, listProperties, listProperties, listProperties, listProperties, listProperties, listProperties, set, set, set

Methods inherited from class java.lang.Object

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

Constructor Details

QueryProfileProperties

public QueryProfileProperties(CompiledQueryProfile profile)

QueryProfileProperties

@Deprecated
public QueryProfileProperties(CompiledQueryProfile profile,
 com.yahoo.language.process.Embedder embedder)

Deprecated.

QueryProfileProperties

@Deprecated
public QueryProfileProperties(CompiledQueryProfile profile,
 Map<String,com.yahoo.language.process.Embedder> embedders)

Deprecated.

Creates an instance from a profile, throws an exception if the given profile is null

QueryProfileProperties

public QueryProfileProperties(CompiledQueryProfile profile,
 Map<String,com.yahoo.language.process.Embedder> embedders,
 ai.vespa.cloud.ZoneInfo zoneInfo)

Creates an instance from a profile, throws an exception if the given profile is null

Method Details

getQueryProfile

public CompiledQueryProfile getQueryProfile()

Returns the query profile backing this, or null if none

get

public Object get(com.yahoo.processing.request.CompoundName name,
 Map<String,String> context,
 com.yahoo.processing.request.Properties substitution)

Gets a value from the query profile, or from the nested profile if the value is null

Overrides:

get in class com.yahoo.processing.request.Properties

set

public void set(com.yahoo.processing.request.CompoundName name,
 Object value,
 Map<String,String> context)

Sets a value in this query profile

Overrides:

set in class com.yahoo.processing.request.Properties

Throws:

com.yahoo.processing.IllegalInputException - if this property cannot be set in the wrapped query profile

requireSettable

public void requireSettable(com.yahoo.processing.request.CompoundName name,
 Object value,
 Map<String,String> context)

Description copied from class: Properties

Throws IllegalInputException if the given key cannot be set to the given value. This default implementation just passes to the chained properties, if any.

Overrides:

requireSettable in class Properties

clearAll

public void clearAll(com.yahoo.processing.request.CompoundName name,
 Map<String,String> context)

Overrides:

clearAll in class com.yahoo.processing.request.Properties

listProperties

public Map<String,Object> listProperties(com.yahoo.processing.request.CompoundName path,
 Map<String,String> context,
 com.yahoo.processing.request.Properties substitution)

Overrides:

listProperties in class com.yahoo.processing.request.Properties

isComplete

public boolean isComplete(StringBuilder firstMissingName,
 Map<String,String> context)

clone

public QueryProfileProperties clone()

Overrides:

clone in class Properties