org.openimaj.util.function.context

Class ContextFunctionAdaptor<IN,OUT>

java.lang.Object

org.openimaj.util.function.context.ContextAdaptor<Function<IN,OUT>,IN,OUT>

org.openimaj.util.function.context.ContextFunctionAdaptor<IN,OUT>

Type Parameters:

IN - Type of input to the adapted function

OUT - Type of output of the adapted function

All Implemented Interfaces:

Function<Context,Context>

public class ContextFunctionAdaptor<IN,OUT>
extends ContextAdaptor<Function<IN,OUT>,IN,OUT>
implements Function<Context,Context>

An adaptor that allows a Function to be applied to a single element of a Context, and store its output in a (potentially) different slot of the Context.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.util.function.context.ContextAdaptor

extract, inner, insert

Constructor Summary

Constructors

Constructor and Description
ContextFunctionAdaptor(Function<IN,OUT> inner, ContextExtractor<IN> extract, ContextInsertor<OUT> insert)
ContextFunctionAdaptor(Function<IN,OUT> inner, String extract, String insert) Construct ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result in a different key.
ContextFunctionAdaptor(String both, Function<IN,OUT> inner) Construct ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result with the same key.

Method Summary

Modifier and Type	Method and Description
Context	apply(Context in) Apply the function to the input argument and return the result.
static <IN,OUT> Function<Context,Context>	create(String extract, String insert, Function<IN,OUT> inner) Create a new ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result in a different key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextFunctionAdaptor

public ContextFunctionAdaptor(Function<IN,OUT> inner,
                              ContextExtractor<IN> extract,
                              ContextInsertor<OUT> insert)

Parameters:

inner -

extract -

insert -

ContextFunctionAdaptor

public ContextFunctionAdaptor(Function<IN,OUT> inner,
                              String extract,
                              String insert)

Construct ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result in a different key.

Parameters:

extract - the key to pull data from

insert - the key to write the result to

inner - the function to apply

ContextFunctionAdaptor

public ContextFunctionAdaptor(String both,
                              Function<IN,OUT> inner)

Construct ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result with the same key.

Parameters:

both - the extract and insert key

inner - the function to apply

Method Detail

apply

public Context apply(Context in)

Description copied from interface: Function

Apply the function to the input argument and return the result.

Specified by:

apply in interface Function<Context,Context>

Parameters:

in - the input object

Returns:

the result of the function

create

public static <IN,OUT> Function<Context,Context> create(String extract,
                                                        String insert,
                                                        Function<IN,OUT> inner)

Create a new ContextFunctionAdaptor that reads data from a given key, applies a function and sets the result in a different key.

Parameters:

extract - the key to pull data from

insert - the key to write the result to

inner - the function to apply

Returns:

the new ContextFunctionAdaptor