Execution.Context (container-search 6.192.4 API)

java.lang.Object
- com.yahoo.search.searchchain.Execution.Context

Enclosing class:

Execution
```
public static final class Execution.Context
extends Object
```
The execution context is the search chain's current view of the indexes, search chain registrys, etc. Searcher instances may set values here to change the behavior of the rest of the search chain.
The Context class simply carries a set of objects which define the environment for the search. Important: All objects available through context need to be either truly immutable or support the freeze pattern.
If you are implementing a searcher where you need to create a new Context instance to create an Execution, you should use the context from the execution the searcher was invoked from. You can also copy (Context.shallowCopy()) the incoming context if it is necessary to do more. In other words, a minimal example would be:
new Execution(searchChain, execution.context())

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`breakdown` Whether the container was considered to be in a breakdown state when this query started.
`private boolean`	`detailedDiagnostics` Whether the search should perform detailed diagnostics.
`private IndexFacts`	`indexFacts`
`private com.yahoo.language.Linguistics`	`linguistics` The current linguistics.
`private Execution`	`owner` Always set if this context belongs to an execution, never set if it does not.
`private RendererRegistry`	`rendererRegistry` The current template registry.
`private SearchChainRegistry`	`searchChainRegistry` The search chain registry current when this execution was created, or when the registry was first accessed, or null if it was not set on creation or has been accessed yet.
`private SpecialTokenRegistry`	`tokenRegistry` The current set of special tokens.

Constructor Summary

Constructors
Constructor and Description
`Context()` Create a context used to carry state into another context
`Context(Execution owner)` Create a context which belongs to an execution
`Context(SearchChainRegistry searchChainRegistry, IndexFacts indexFacts, SpecialTokenRegistry tokenRegistry, RendererRegistry rendererRegistry, com.yahoo.language.Linguistics linguistics)` Creates a context from arguments, all of which may be null, though this can be risky.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) Execution.Context`	`copyIfChanged(Execution.Context previous)` This is used when building the Context stack.
`private com.yahoo.processing.execution.Execution.Environment`	`createChildEnvironment()` Creates a child environment if this has an owner, or a root environment otherwise
`private com.yahoo.processing.execution.Execution.Trace`	`createChildTrace()` Creates a child trace if this has an owner, or a root trace otherwise
`static Execution.Context`	`createContextStub()` Creates a context stub with no information.
`static Execution.Context`	`createContextStub(IndexFacts indexFacts)` Create a Context instance where only the index related settings are initialized.
`static Execution.Context`	`createContextStub(SearchChainRegistry searchChainRegistry, IndexFacts indexFacts)` Create a Context instance where only the search chain registry and index facts are initialized.
`static Execution.Context`	`createContextStub(SearchChainRegistry searchChainRegistry, IndexFacts indexFacts, com.yahoo.language.Linguistics linguistics)` Create a Context instance where only the search chain registry, index facts and linguistics are initialized.
`boolean`	`equals(Execution.Context other)`
`boolean`	`equals(Object other)`
`(package private) void`	`fill(Execution.Context other)` The brutal version of populateFrom().
`boolean`	`getBreakdown()` If too many queries time out, the search handler will assume the system is in a breakdown state.
`boolean`	`getDetailedDiagnostics()` The container has some internal diagnostics mechanisms which may be costly, and therefore not active by default.
`IndexFacts`	`getIndexFacts()` Returns information about the indexes specified by the search definitions used in this system, or null if not know.
`com.yahoo.language.Linguistics`	`getLinguistics()` Returns the `Linguistics` object assigned to this Context.
`SpecialTokenRegistry`	`getTokenRegistry()`
`int`	`hashCode()`
`void`	`populateFrom(Execution.Context sourceContext)` Populate missing values in this from the given context.
`RendererRegistry`	`rendererRegistry()` Returns the template registry to use with this execution.
`SearchChainRegistry`	`searchChainRegistry()` Returns the search chain registry to use with this execution.
`void`	`setBreakdown(boolean breakdown)`
`void`	`setDetailedDiagnostics(boolean breakdown)`
`void`	`setIndexFacts(IndexFacts indexFacts)` Use this to override index settings for the searchers below a given searcher, the easiest way to do this is to wrap the incoming IndexFacts instance in a subclass.
`void`	`setLinguistics(com.yahoo.language.Linguistics linguistics)`
`void`	`setTokenRegistry(SpecialTokenRegistry tokenRegistry)` Wrapping the incoming special token registry and then setting the wrapper as the token registry, can be used for changing the set of special tokens used by succeeding searchers.
`Execution.Context`	`shallowCopy()` Standard shallow copy, the new instance will carry the same references as this.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - detailedDiagnostics
```
private boolean detailedDiagnostics
```
    Whether the search should perform detailed diagnostics.
  - breakdown
```
private boolean breakdown
```
    Whether the container was considered to be in a breakdown state when this query started.
  - searchChainRegistry
```
private SearchChainRegistry searchChainRegistry
```
    The search chain registry current when this execution was created, or when the registry was first accessed, or null if it was not set on creation or has been accessed yet. No setter method is intentional.
  - indexFacts
```
private IndexFacts indexFacts
```
  - tokenRegistry
```
private SpecialTokenRegistry tokenRegistry
```
    The current set of special tokens.
  - rendererRegistry
```
private RendererRegistry rendererRegistry
```
    The current template registry.
  - linguistics
```
private com.yahoo.language.Linguistics linguistics
```
    The current linguistics.
  - owner
```
private final Execution owner
```
    Always set if this context belongs to an execution, never set if it does not.
- Constructor Detail
  - Context
```
Context()
```
    Create a context used to carry state into another context
  - Context
```
Context(Execution owner)
```
    Create a context which belongs to an execution
  - Context
```
public Context(SearchChainRegistry searchChainRegistry,
               IndexFacts indexFacts,
               SpecialTokenRegistry tokenRegistry,
               RendererRegistry rendererRegistry,
               com.yahoo.language.Linguistics linguistics)
```
    Creates a context from arguments, all of which may be null, though this can be risky. If you are doing this outside a test, it is usually better to do something like execution.context().shallowCopy() instead, and then set the fields you need to change. It is also safe to use the context from the incoming execution directly. In other words, a plug-in writer should practically never construct a Context instance directly.
    This context is never attached to an execution but is used to carry state into another context.
- Method Detail
  - createContextStub
```
public static Execution.Context createContextStub()
```
    Creates a context stub with no information. This is for unit testing.
  - createContextStub
```
public static Execution.Context createContextStub(IndexFacts indexFacts)
```
    Create a Context instance where only the index related settings are initialized. This is for unit testing.
  - createContextStub
```
public static Execution.Context createContextStub(SearchChainRegistry searchChainRegistry,
                                                  IndexFacts indexFacts)
```
    Create a Context instance where only the search chain registry and index facts are initialized. This is for unit testing.
  - createContextStub
```
public static Execution.Context createContextStub(SearchChainRegistry searchChainRegistry,
                                                  IndexFacts indexFacts,
                                                  com.yahoo.language.Linguistics linguistics)
```
    Create a Context instance where only the search chain registry, index facts and linguistics are initialized. This is for unit testing.
  - populateFrom
```
public void populateFrom(Execution.Context sourceContext)
```
    Populate missing values in this from the given context. Values which are non-null in this will not be overwritten.
    
    Parameters:
    
    sourceContext - the context from which to get the parameters
  - fill
```
void fill(Execution.Context other)
```
    The brutal version of populateFrom().
    
    Parameters:
    
    other - a Context instance this will copy all state from
  - equals
```
public boolean equals(Execution.Context other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - shallowCopy
```
public Execution.Context shallowCopy()
```
    Standard shallow copy, the new instance will carry the same references as this.
    
    Returns:
    
    a new instance which is a shallow copy
  - copyIfChanged
```
Execution.Context copyIfChanged(Execution.Context previous)
```
    This is used when building the Context stack. If Context has been changed since last time, build a new object. Otherwise simply return the previous snapshot.
    
    Parameters:
    
    previous - another Context instance to compare with
    
    Returns:
    
    a copy of this, or previous
  - getIndexFacts
```
public IndexFacts getIndexFacts()
```
    Returns information about the indexes specified by the search definitions used in this system, or null if not know.
  - setIndexFacts
```
public void setIndexFacts(IndexFacts indexFacts)
```
    Use this to override index settings for the searchers below a given searcher, the easiest way to do this is to wrap the incoming IndexFacts instance in a subclass. E.g. execution.context().setIndexFacts(new WrapperClass(execution.context().getIndexFacts())).
    
    Parameters:
    
    indexFacts - an instance to override the following searcher's view of the indexes.
  - searchChainRegistry
```
public SearchChainRegistry searchChainRegistry()
```
    Returns the search chain registry to use with this execution. This is a snapshot taken at creation of this execution, use Context.shallowCopy() to get a correctly instantiated Context if making a custom Context instance.
  - rendererRegistry
```
public RendererRegistry rendererRegistry()
```
    Returns the template registry to use with this execution. This is a snapshot taken at creation of this execution.
  - getTokenRegistry
```
public SpecialTokenRegistry getTokenRegistry()
```
    Returns:
    
    the current set of special strings for the query tokenizer
  - setTokenRegistry
```
public void setTokenRegistry(SpecialTokenRegistry tokenRegistry)
```
    Wrapping the incoming special token registry and then setting the wrapper as the token registry, can be used for changing the set of special tokens used by succeeding searchers. E.g. execution.context().setTokenRegistry(new WrapperClass(execution.context().getTokenRegistry())).
    
    Parameters:
    
    tokenRegistry - a new registry for overriding behavior of following searchers
  - setDetailedDiagnostics
```
public void setDetailedDiagnostics(boolean breakdown)
```
  - getDetailedDiagnostics
```
public boolean getDetailedDiagnostics()
```
    The container has some internal diagnostics mechanisms which may be costly, and therefore not active by default. Any general diagnostic mechanism which should not be active be default, may inspect that state here. If breakdown is assumed, a certain percentage of queries will have this set automatically.
    
    Returns:
    
    whether components exposing different level of diagnostics should go for the most detailed level
  - getBreakdown
```
public boolean getBreakdown()
```
    If too many queries time out, the search handler will assume the system is in a breakdown state. This state is propagated here.
    
    Returns:
    
    whether the system is assumed to be in a breakdown state
  - setBreakdown
```
public void setBreakdown(boolean breakdown)
```
  - getLinguistics
```
public com.yahoo.language.Linguistics getLinguistics()
```
    Returns the Linguistics object assigned to this Context. This object provides access to all the linguistic-related APIs, and comes pre-configured with the Execution given.
    
    Returns:
    
    The current Linguistics.
  - setLinguistics
```
public void setLinguistics(com.yahoo.language.Linguistics linguistics)
```
  - createChildTrace
```
private com.yahoo.processing.execution.Execution.Trace createChildTrace()
```
    Creates a child trace if this has an owner, or a root trace otherwise
  - createChildEnvironment
```
private com.yahoo.processing.execution.Execution.Environment createChildEnvironment()
```
    Creates a child environment if this has an owner, or a root environment otherwise

Class Execution.Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

detailedDiagnostics

breakdown

searchChainRegistry

indexFacts

tokenRegistry

rendererRegistry

linguistics

owner

Constructor Detail

Context

Context

Context

Method Detail

createContextStub

createContextStub

createContextStub

createContextStub

populateFrom

fill

equals

hashCode

equals

shallowCopy

copyIfChanged

getIndexFacts

setIndexFacts

searchChainRegistry

rendererRegistry

getTokenRegistry

setTokenRegistry

setDetailedDiagnostics

getDetailedDiagnostics

getBreakdown

setBreakdown

getLinguistics

setLinguistics

createChildTrace

createChildEnvironment