Package com.yahoo.searchlib.rankingexpression.rule

Class SerializationContext

java.lang.Object

com.yahoo.searchlib.rankingexpression.rule.FunctionReferenceContext

com.yahoo.searchlib.rankingexpression.rule.SerializationContext

public class SerializationContext
extends FunctionReferenceContext

Context needed to serialize an expression to a string. This has the lifetime of a single serialization

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
SerializationContext()	Create a context for a single serialization task
SerializationContext(com.google.common.collect.ImmutableMap<String,ExpressionFunction> functions, Map<String,String> bindings, Map<String,String> serializedFunctions)	Deprecated, for removal: This API element is subject to removal in a future version. Use instead
SerializationContext(Collection<ExpressionFunction> functions)	Deprecated, for removal: This API element is subject to removal in a future version. Use instead
SerializationContext(Collection<ExpressionFunction> functions, Map<String,String> bindings)	Deprecated, for removal: This API element is subject to removal in a future version. Use instead
SerializationContext(Collection<ExpressionFunction> functions, Map<String,String> bindings, com.yahoo.tensor.evaluation.TypeContext<Reference> typeContext)	Create a context for a single serialization task
SerializationContext(Collection<ExpressionFunction> functions, Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>> typeContext)
SerializationContext(Map<String,ExpressionFunction> functions)	Deprecated, for removal: This API element is subject to removal in a future version. Use instead
SerializationContext(Map<String,ExpressionFunction> functions, Map<String,String> bindings, Map<String,String> serializedFunctions)	Deprecated, for removal: This API element is subject to removal in a future version. Use instead
SerializationContext(Map<String,ExpressionFunction> functions, Map<String,String> bindings, Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>> typeContext, Map<String,String> serializedFunctions)

Method Summary

Modifier and Type	Method	Description
void	addArgumentTypeSerialization(String functionName, String argumentName, com.yahoo.tensor.TensorType type)	Adds the serialization of the argument type to a function
void	addFunctionSerialization(String name, String expressionString)	Adds the serialization of a function
void	addFunctionTypeSerialization(String functionName, com.yahoo.tensor.TensorType type)	Adds the serialization of the return type of a function
boolean	needSerialization(String functionName)
Map<String,String>	serializedFunctions()
Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>>	typeContext()	Returns the type context of this, if it is able to resolve types.
SerializationContext	withBindings(Map<String,String> bindings)	Returns a new context with the bindings replaced by the given bindings
SerializationContext	withoutBindings()	Returns a fresh context without bindings

Methods inherited from class com.yahoo.searchlib.rankingexpression.rule.FunctionReferenceContext

functions, getBinding, getFunction, getFunctions

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializationContext

public SerializationContext()

Create a context for a single serialization task

SerializationContext

@Deprecated(forRemoval=true,
            since="7")
public SerializationContext(Collection<ExpressionFunction> functions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead

SerializationContext

public SerializationContext(Collection<ExpressionFunction> functions,
                            Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>> typeContext)

SerializationContext

@Deprecated(forRemoval=true,
            since="7")
public SerializationContext(Map<String,ExpressionFunction> functions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead

SerializationContext

@Deprecated(forRemoval=true,
            since="7")
public SerializationContext(Collection<ExpressionFunction> functions,
                            Map<String,String> bindings)

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead

SerializationContext

public SerializationContext(Collection<ExpressionFunction> functions,
                            Map<String,String> bindings,
                            com.yahoo.tensor.evaluation.TypeContext<Reference> typeContext)

Create a context for a single serialization task

SerializationContext

@Deprecated(forRemoval=true,
            since="7")
public SerializationContext(Map<String,ExpressionFunction> functions,
                            Map<String,String> bindings,
                            Map<String,String> serializedFunctions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead

SerializationContext

public SerializationContext(Map<String,ExpressionFunction> functions,
                            Map<String,String> bindings,
                            Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>> typeContext,
                            Map<String,String> serializedFunctions)

SerializationContext

@Deprecated(forRemoval=true,
            since="7")
public SerializationContext(com.google.common.collect.ImmutableMap<String,ExpressionFunction> functions,
                            Map<String,String> bindings,
                            Map<String,String> serializedFunctions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead

Method Detail

typeContext

public Optional<com.yahoo.tensor.evaluation.TypeContext<Reference>> typeContext()

Returns the type context of this, if it is able to resolve types.

addFunctionSerialization

public void addFunctionSerialization(String name,
                                     String expressionString)

Adds the serialization of a function

addArgumentTypeSerialization

public void addArgumentTypeSerialization(String functionName,
                                         String argumentName,
                                         com.yahoo.tensor.TensorType type)

Adds the serialization of the argument type to a function

addFunctionTypeSerialization

public void addFunctionTypeSerialization(String functionName,
                                         com.yahoo.tensor.TensorType type)

Adds the serialization of the return type of a function

withBindings

public SerializationContext withBindings(Map<String,String> bindings)

Description copied from class: FunctionReferenceContext

Returns a new context with the bindings replaced by the given bindings

Overrides:

withBindings in class FunctionReferenceContext

withoutBindings

public SerializationContext withoutBindings()

Returns a fresh context without bindings

Overrides:

withoutBindings in class FunctionReferenceContext

serializedFunctions

public Map<String,String> serializedFunctions()

needSerialization

public boolean needSerialization(String functionName)