com.attivio.sdk.server.udf

Interface UserDefinedFieldEvaluator

public interface UserDefinedFieldEvaluator

Interface for a user defined field implementation.

Thread Safety: An instance of UserDefinedFieldEvaluator will only be accessed by a single thread.

Method Summary

Modifier and Type	Method and Description
void	configure(UserDefinedFieldContext context, UserDefinedField input, ArgumentInfo[] args) Field initialization.
void	evaluate(OutputValue output, InputValue[] args) Evaluate the result of the function and add it to output.

Method Detail

configure

void configure(UserDefinedFieldContext context,
               UserDefinedField input,
               ArgumentInfo[] args)

Field initialization.

This should include:

• Parameters on input should be validated and stored.
• args should be type checked and validated.
• Output type for input should be validated.
• Any internal structures should be initialized.

Parameters:

context - QueryRequest level context information for initializing fields.

input - The input UserDefinedField.

args - Type information for supplied arguments.

Throws:

IllegalArgumentException - if incorrect number of arguments are provided, data types for arguments are not supported, output type is invalid, or parameters are illegal.

evaluate

void evaluate(OutputValue output,
              InputValue[] args)

Evaluate the result of the function and add it to output.

args will map to ArgumentInfos provided in configure(UserDefinedFieldContext, UserDefinedField, ArgumentInfo[]).