Package com.yahoo.search.query.profile

Class BackedOverridableQueryProfile

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.component.provider.FreezableSimpleComponent

com.yahoo.search.query.profile.QueryProfile

com.yahoo.search.query.profile.OverridableQueryProfile

com.yahoo.search.query.profile.BackedOverridableQueryProfile

All Implemented Interfaces:

com.yahoo.component.Component, com.yahoo.component.Deconstructable, com.yahoo.component.provider.Freezable, Cloneable, Comparable<com.yahoo.component.Component>

public class BackedOverridableQueryProfile
extends OverridableQueryProfile
implements Cloneable

A wrapper of a query profile where overrides to the values in the referenced profile can be set. This is used to allow configured overrides (in a particular referencing profile) of a referenced query profile. Properties which are defined as not overridable in the type (if any) of the referenced query profile cannot be set.

Author:

bratseth

Field Summary

Fields inherited from class com.yahoo.search.query.profile.QueryProfile

owner

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor	Description
BackedOverridableQueryProfile(QueryProfile backingProfile)	Creates an overridable profile from the given backing profile.

Method Summary

Modifier and Type	Method	Description
void	addInherited(QueryProfile inherited)	Adds a profile to the end of the inherited list of this.
BackedOverridableQueryProfile	clone()	Returns a clone of this which can be independently overridden, but which refers to the same backing profile
protected QueryProfile	createSubProfile(String name, DimensionBinding dimensionBinding)	Looks up all inherited profiles and adds any that matches this name.
void	freeze()	Switches this from write-only to read-only mode.
QueryProfile	getBacking()	Returns the query profile backing this
protected Map<String,Object>	getContent()	Returns all the content from this: All the values in this, and all values in the backing where an overriding value is not set in this
protected Object	getContent(String localKey)	Returns a value from the content of this: The value in this, or the value from the backing if not set in this
List<String>	getDimensions()	Returns the variant dimensions to be used in this - an unmodifiable list of dimension names
String	getSource()
boolean	isExplicit()
protected Boolean	isLocalInstanceOverridable(String localName)
protected Object	localLookup(String localName, DimensionBinding dimensionBinding)	Do a variant-aware content lookup in this
String	toString()
protected void	visitInherited(boolean allowContent, com.yahoo.search.query.profile.QueryProfileVisitor visitor, DimensionBinding dimensionBinding, QueryProfile owner)
protected void	visitVariants(boolean allowContent, com.yahoo.search.query.profile.QueryProfileVisitor visitor, DimensionBinding dimensionBinding)

Methods inherited from class com.yahoo.search.query.profile.OverridableQueryProfile

checkAndConvertAssignment

Methods inherited from class com.yahoo.search.query.profile.QueryProfile

accept, addInherited, addInherited, compile, convertToSubstitutionString, declaredContent, get, get, get, get, get, get, get, getFieldDescription, getOwner, getType, getValue, getVariants, inherited, isDeclaredOverridable, listValues, listValues, listValues, listValues, listValues, lookup, lookup, set, set, set, set, set, set, setDimensions, setLocalNode, setOverridable, setOverridable, setType, setValue, validateName

Methods inherited from class com.yahoo.component.provider.FreezableSimpleComponent

ensureNotFrozen, isFrozen

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

BackedOverridableQueryProfile

public BackedOverridableQueryProfile(QueryProfile backingProfile)

Creates an overridable profile from the given backing profile. The backing profile will never be written to.

Parameters:

backingProfile - the backing profile, which is assumed read only, never null

Method Detail

getSource

public String getSource()

Overrides:

getSource in class QueryProfile

freeze

public void freeze()

Description copied from class: QueryProfile

Switches this from write-only to read-only mode. This profile can never be modified again after this method returns. Calling this on an already frozen profile has no effect. Calling this will also freeze any profiles inherited and referenced by this.

Specified by:

freeze in interface com.yahoo.component.provider.Freezable

Overrides:

freeze in class QueryProfile

localLookup

protected Object localLookup(String localName,
                             DimensionBinding dimensionBinding)

Description copied from class: QueryProfile

Do a variant-aware content lookup in this

Overrides:

localLookup in class QueryProfile

isLocalInstanceOverridable

protected Boolean isLocalInstanceOverridable(String localName)

Overrides:

isLocalInstanceOverridable in class QueryProfile

createSubProfile

protected QueryProfile createSubProfile(String name,
                                        DimensionBinding dimensionBinding)

Description copied from class: QueryProfile

Looks up all inherited profiles and adds any that matches this name. This default implementation returns an empty profile.

Overrides:

createSubProfile in class OverridableQueryProfile

clone

public BackedOverridableQueryProfile clone()

Returns a clone of this which can be independently overridden, but which refers to the same backing profile

Overrides:

clone in class OverridableQueryProfile

getBacking

public QueryProfile getBacking()

Returns the query profile backing this

addInherited

public void addInherited(QueryProfile inherited)

Description copied from class: QueryProfile

Adds a profile to the end of the inherited list of this. Throws an exception if this is frozen.

Overrides:

addInherited in class QueryProfile

visitVariants

protected void visitVariants(boolean allowContent,
                             com.yahoo.search.query.profile.QueryProfileVisitor visitor,
                             DimensionBinding dimensionBinding)

Overrides:

visitVariants in class QueryProfile

visitInherited

protected void visitInherited(boolean allowContent,
                              com.yahoo.search.query.profile.QueryProfileVisitor visitor,
                              DimensionBinding dimensionBinding,
                              QueryProfile owner)

Overrides:

visitInherited in class QueryProfile

getContent

protected Object getContent(String localKey)

Returns a value from the content of this: The value in this, or the value from the backing if not set in this

Overrides:

getContent in class QueryProfile

getContent

protected Map<String,Object> getContent()

Returns all the content from this: All the values in this, and all values in the backing where an overriding value is not set in this

Overrides:

getContent in class QueryProfile

toString

public String toString()

Overrides:

toString in class OverridableQueryProfile

isExplicit

public boolean isExplicit()

Overrides:

isExplicit in class QueryProfile

getDimensions

public List<String> getDimensions()

Description copied from class: QueryProfile

Returns the variant dimensions to be used in this - an unmodifiable list of dimension names

Overrides:

getDimensions in class QueryProfile