org.openimaj.util.function.context

Class ContextListFilter<IN>

java.lang.Object

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

org.openimaj.util.function.context.ContextListFilter<IN>

Type Parameters:

IN - Type of items in the list

All Implemented Interfaces:

Function<Context,Context>

public class ContextListFilter<IN>
extends ContextAdaptor<Predicate<IN>,List<IN>,List<IN>>
implements Function<Context,Context>

Filter a list of items belonging to a single Context entry using a predicate

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
ContextListFilter(Predicate<IN> inner, ContextExtractor<List<IN>> extract, ContextInsertor<List<IN>> insert) Construct with the given options.
ContextListFilter(Predicate<IN> inner, String both) Construct with the given predicate.
ContextListFilter(Predicate<IN> inner, String extract, String insert) Construct with the given predicate.

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

ContextListFilter

public ContextListFilter(Predicate<IN> inner,
                         ContextExtractor<List<IN>> extract,
                         ContextInsertor<List<IN>> insert)

Construct with the given options.

Parameters:

inner - the predicate

extract - the extractor

insert - the insertor

ContextListFilter

public ContextListFilter(Predicate<IN> inner,
                         String extract,
                         String insert)

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

Parameters:

inner - the predicate

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

ContextListFilter

public ContextListFilter(Predicate<IN> inner,
                         String both)

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

Parameters:

inner - the predicate

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