org.openimaj.util.function.context

Class ContextAdaptor<ADAPTED,IN,OUT>

java.lang.Object

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

Type Parameters:

ADAPTED - The type of object being adapted

IN - The input type of the object being adapted

OUT - The output type of the object being adapted

Direct Known Subclasses:

ContextFunctionAdaptor, ContextListFilter, ContextListFunction, ContextOperationAdaptor, ContextPredicateAdaptor

public abstract class ContextAdaptor<ADAPTED,IN,OUT>
extends Object

Base class that holds the elements required to adapt something (i.e. a Function) to work around around a single element of a Context and output to a potentially different key of that Context.

This base class just holds the parts required for the adaption (the object being adapted, and the ContextExtractor and ContextInsertor), but doesn't actually provide any functionality.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ContextExtractor<IN>	extract
protected ADAPTED	inner
protected ContextInsertor<OUT>	insert

Constructor Summary

Constructors

Constructor and Description
ContextAdaptor(ADAPTED inner, ContextExtractor<IN> extract, ContextInsertor<OUT> insert) Construct with the given options.
ContextAdaptor(ADAPTED inner, String keyin, String keyout) Construct with the given object to adapt.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

inner

protected ADAPTED inner

extract

protected ContextExtractor<IN> extract

insert

protected ContextInsertor<OUT> insert

Constructor Detail

ContextAdaptor

public ContextAdaptor(ADAPTED inner,
                      ContextExtractor<IN> extract,
                      ContextInsertor<OUT> insert)

Construct with the given options.

Parameters:

inner - the object being adapted

extract - the extractor

insert - the insertor

ContextAdaptor

public ContextAdaptor(ADAPTED inner,
                      String keyin,
                      String keyout)

Construct with the given object to adapt. The insertor and extractor are created from the given keys.

Parameters:

inner - the object being adapted

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

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