Package org.qubership.atp.dataset.macros

Interface EvaluationContext

All Known Implementing Classes:

EvalContextImpl

public interface EvaluationContext

Method Summary

Modifier and Type	Method	Description
String	evaluate(String inputText)	Evaluates text using this context.
String	evaluate(Parameter parameter, String value)	Evaluates parameter using this context.
String	evaluate(OverlapItem.Reachable source, Parameter target, String value)	Finds context to evaluate parameter in.
<O> O	executeInAnyContext(Iterator<? extends EvaluationContext> of, MacroContext.ContextedTask<O> toExecute)	Executes MacroContext.ContextedTask in a context chain.
DataSet	getDs()
DataSetList	getDsl()
Iterator<? extends EvaluationContext>	getNonStrictContexts()	May be empty.
EvaluationContext	getParent()
default EvaluationContext	getRoot()	Returns root context of a context chain.
Iterator<? extends EvaluationContext>	getStrictContexts()	May not be empty.
List<RefArg<Attribute>>	relativizePathFromSharedToThis(EvaluationContext shared, List<RefArg<Attribute>> attrArgs)	When you are searching for params in shared context by using refs, defined in this context, you should relativize attribute path like if param was defined in shared context.
void	resolveArguments(List<? extends RefArg<?>> args)

Method Details

getParent

@Nullable
EvaluationContext getParent()

getDsl

@Nonnull
DataSetList getDsl()

getDs

@Nonnull
DataSet getDs()

relativizePathFromSharedToThis

@Nonnull
List<RefArg<Attribute>> relativizePathFromSharedToThis(@Nonnull
 EvaluationContext shared,
 @Nonnull
 List<RefArg<Attribute>> attrArgs)

When you are searching for params in shared context by using refs, defined in this context, you should relativize attribute path like if param was defined in shared context.

getRoot

@Nonnull
default EvaluationContext getRoot()

Returns root context of a context chain.

executeInAnyContext

@Nonnull
<O> O executeInAnyContext(@Nonnull
 Iterator<? extends EvaluationContext> of,
 @Nonnull
 MacroContext.ContextedTask<O> toExecute)
                   throws CtxEvalException

Executes MacroContext.ContextedTask in a context chain. Starting context is the provided one (current). Going upper through callers contexts if the task failed with an exception. Returns first valid task result.

Parameters:

of - typically is getStrictContexts().

Throws:

CtxEvalException - if args are not resolved or task failed with an exception in all possible contexts.

resolveArguments

void resolveArguments(@Nonnull
 List<? extends RefArg<?>> args)
               throws Exception

Throws:

Exception

evaluate

@Nonnull
String evaluate(@Nonnull
 OverlapItem.Reachable source,
 @Nonnull
 Parameter target,
 @Nonnull
 String value)
         throws CtxEvalException

Finds context to evaluate parameter in. Evaluates parameter using found context.

Parameters:

target - is source.getParameter().get(). Ensure that it exists first.

value - is source.getParameter().get().getValue().get(). Ensure that it exists first.

Throws:

IllegalArgumentException - if value is empty.

CtxEvalException

evaluate

@Nonnull
String evaluate(@Nonnull
 Parameter parameter,
 @Nonnull
 String value)
         throws CtxEvalException

Evaluates parameter using this context. Use evaluate(OverlapItem.Reachable, Parameter, String) when possible!

Parameters:

parameter - to evaluate.

value - is parameter.getValue().get(). Ensure that it is exists first.

Throws:

IllegalArgumentException - if value is empty.

CtxEvalException

evaluate

@Nonnull
String evaluate(@Nonnull
 String inputText)
         throws CtxEvalException

Evaluates text using this context. Use evaluate(Parameter, String) when possible!

Parameters:

inputText - text to evaluate.

Throws:

IllegalArgumentException - if value is empty.

CtxEvalException

getStrictContexts

Iterator<? extends EvaluationContext> getStrictContexts()

May not be empty. Returned contexts are relative and relativizePathFromSharedToThis(EvaluationContext, List) should be used for each of them.

Returns:

callers plus this.

getNonStrictContexts

Iterator<? extends EvaluationContext> getNonStrictContexts()

May be empty. Returned contexts are not relative and relativizePathFromSharedToThis(EvaluationContext, List) should not be used for each of them. Used when no one string context fits to your needs.

Returns:

additional contexts.