org.openimaj.util.function.context

Class ContextListFunction<IN,OUT>

java.lang.Object

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

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

Type Parameters:

IN - The input type of the function (and the type of elements in the list)

OUT - The output type of the function (and type of elements in the resultant list)

All Implemented Interfaces:

Function<Context,Context>

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

Apply a Function to a list held within a single element of a Context, writing the resultant list back to the Context, potentially with a different key.

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
ContextListFunction(Function<IN,OUT> inner, ContextExtractor<List<IN>> extract, ContextInsertor<List<OUT>> insert) Construct with the given options.
ContextListFunction(Function<IN,OUT> inner, String both) Construct with the given function.
ContextListFunction(Function<IN,OUT> inner, String extract, String insert) Construct with the function.

Method Summary

Modifier and Type	Method and Description
Context	apply(Context in) Apply the function to the input argument and return the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextListFunction

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

Construct with the given options.

Parameters:

inner - the function

extract - the extractor

insert - the insertor

ContextListFunction

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

Construct with the function. The insertor and extractor are created from the given keys.

Parameters:

inner - the function

extract - the key to extract from the context to produce the input for the object

insert - the key to insert with the the output for the object

ContextListFunction

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

Construct with the given function. The insertor and extractor are created from the same key, so the output will overwrite the input.

Parameters:

inner - the function

both - the key to extract/insert

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