com.yahoo.search.query.profile.compiled

Class CompiledQueryProfile

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.search.query.profile.compiled.CompiledQueryProfile

All Implemented Interfaces:

com.yahoo.component.Component, Cloneable, Comparable<com.yahoo.component.Component>

public class CompiledQueryProfile
extends com.yahoo.component.AbstractComponent
implements Cloneable

A query profile in a state where it is optimized for fast lookups.

Author:

bratseth

Field Summary

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor and Description

CompiledQueryProfile(com.yahoo.component.ComponentId id, QueryProfileType type, DimensionalMap<com.yahoo.processing.request.CompoundName,Object> entries, DimensionalMap<com.yahoo.processing.request.CompoundName,QueryProfileType> types, DimensionalMap<com.yahoo.processing.request.CompoundName,Object> references, DimensionalMap<com.yahoo.processing.request.CompoundName,Object> unoverridables, CompiledQueryProfileRegistry registry) Creates a new query profile from an id.

Method Summary

Modifier and Type	Method and Description
CompiledQueryProfile	clone()
Object	get(com.yahoo.processing.request.CompoundName name, Map<String,String> context, com.yahoo.processing.request.Properties substitution)
Object	get(String name)
Object	get(String name, Map<String,String> context)
Object	get(String name, Map<String,String> context, com.yahoo.processing.request.Properties substitution)
DimensionalMap<com.yahoo.processing.request.CompoundName,Object>	getReferences() Returns the references reachable from this, or an empty map (never null) if none
CompiledQueryProfileRegistry	getRegistry() Returns the registry this belongs to, or null if none (in which case runtime profile reference assignment won't work)
QueryProfileType	getType() Returns the type of this or null if it has no type
QueryProfileType	getType(com.yahoo.processing.request.CompoundName name, Map<String,String> context) Returns the type of a given prefix reachable from this profile, or null if none
DimensionalMap<com.yahoo.processing.request.CompoundName,QueryProfileType>	getTypes() Returns the types reachable from this, or an empty map (never null) if none
boolean	isOverridable(com.yahoo.processing.request.CompoundName name, Map<String,String> context) Returns whether or not the given field name can be overridden at runtime.
Map<String,Object>	listValues(com.yahoo.processing.request.CompoundName prefix) Return all objects that start with the given prefix path using no context.
Map<String,Object>	listValues(com.yahoo.processing.request.CompoundName prefix, Map<String,String> context) Return all objects that start with the given prefix path.
Map<String,Object>	listValues(com.yahoo.processing.request.CompoundName prefix, Map<String,String> context, com.yahoo.processing.request.Properties substitution) Adds all objects that start with the given path prefix to the given value map.
Map<String,Object>	listValues(String prefix)
Map<String,Object>	listValues(String prefix, Map<String,String> context) Return all objects that start with the given prefix path.
String	toString()

Methods inherited from class com.yahoo.component.AbstractComponent

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

Constructor Detail

CompiledQueryProfile

public CompiledQueryProfile(com.yahoo.component.ComponentId id,
                            QueryProfileType type,
                            DimensionalMap<com.yahoo.processing.request.CompoundName,Object> entries,
                            DimensionalMap<com.yahoo.processing.request.CompoundName,QueryProfileType> types,
                            DimensionalMap<com.yahoo.processing.request.CompoundName,Object> references,
                            DimensionalMap<com.yahoo.processing.request.CompoundName,Object> unoverridables,
                            CompiledQueryProfileRegistry registry)

Creates a new query profile from an id.

Method Detail

getRegistry

public CompiledQueryProfileRegistry getRegistry()

Returns the registry this belongs to, or null if none (in which case runtime profile reference assignment won't work)

getType

public QueryProfileType getType()

Returns the type of this or null if it has no type

isOverridable

public final boolean isOverridable(com.yahoo.processing.request.CompoundName name,
                                   Map<String,String> context)

Returns whether or not the given field name can be overridden at runtime. Attempts to override values which cannot be overridden will not fail but be ignored. Default: true.

Parameters:

name - the name of the field to check

context - the context in which to check, or null if none

getType

public final QueryProfileType getType(com.yahoo.processing.request.CompoundName name,
                                      Map<String,String> context)

Returns the type of a given prefix reachable from this profile, or null if none

getTypes

public DimensionalMap<com.yahoo.processing.request.CompoundName,QueryProfileType> getTypes()

Returns the types reachable from this, or an empty map (never null) if none

getReferences

public DimensionalMap<com.yahoo.processing.request.CompoundName,Object> getReferences()

Returns the references reachable from this, or an empty map (never null) if none

listValues

public final Map<String,Object> listValues(com.yahoo.processing.request.CompoundName prefix)

Return all objects that start with the given prefix path using no context. Use "" to list all.

For example, if {a.d => "a.d-value" ,a.e => "a.e-value", b.d => "b.d-value", then calling listValues("a") will return {"d" => "a.d-value","e" => "a.e-value"}

listValues

public final Map<String,Object> listValues(String prefix)

listValues

public final Map<String,Object> listValues(String prefix,
                                           Map<String,String> context)

Return all objects that start with the given prefix path. Use "" to list all.

For example, if {a.d => "a.d-value" ,a.e => "a.e-value", b.d => "b.d-value", then calling listValues("a") will return {"d" => "a.d-value","e" => "a.e-value"}

listValues

public final Map<String,Object> listValues(com.yahoo.processing.request.CompoundName prefix,
                                           Map<String,String> context)

Return all objects that start with the given prefix path. Use "" to list all.

For example, if {a.d => "a.d-value" ,a.e => "a.e-value", b.d => "b.d-value", then calling listValues("a") will return {"d" => "a.d-value","e" => "a.e-value"}

listValues

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

Adds all objects that start with the given path prefix to the given value map. Use "" to list all.

For example, if {a.d => "a.d-value" ,a.e => "a.e-value", b.d => "b.d-value", then calling listValues("a") will return {"d" => "a.d-value","e" => "a.e-value"}

get

public final Object get(String name)

get

public final Object get(String name,
                        Map<String,String> context)

get

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

get

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

clone

public CompiledQueryProfile clone()

Overrides:

clone in class com.yahoo.component.AbstractComponent

toString

public String toString()

Overrides:

toString in class com.yahoo.component.AbstractComponent