org.openimaj.util.stream.combine

Class ContextStreamCombiner

java.lang.Object

org.openimaj.util.stream.AbstractStream<Context>

org.openimaj.util.stream.combine.ContextStreamCombiner

All Implemented Interfaces:

Iterable<Context>, Iterator<Context>, Stream<Context>

public class ContextStreamCombiner
extends AbstractStream<Context>

A stream combiner takes two streams of Context objects and produces a new stream of Contexts which contain the stream values from both input streams. To combine contexts, prefix strings are added to all the keys to ensure that there is no overlap. The key prefixes can be empty if it is known that the context keys will not collide. The two streams are consumed in two threads which the next() method waits to complete before returning.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ContextStreamCombiner(Stream<Context> a, Stream<Context> b) Construct the combiner to consume the two given streams.
ContextStreamCombiner(Stream<Context> a, Stream<Context> b, String aprefix, String bprefix) Construct the combiner to consume the two given streams, using the given prefixes to modify the keys from the respective streams.

Method Summary

Modifier and Type	Method and Description
static Stream<Context>	combine(Stream<Context> a, Stream<Context> b) Utility method to combine two streams.
boolean	hasNext()
Context	next()

Methods inherited from class org.openimaj.util.stream.AbstractStream

filter, forEach, forEach, forEach, iterator, map, map, parallelForEach, parallelForEach, remove, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ContextStreamCombiner

public ContextStreamCombiner(Stream<Context> a,
                             Stream<Context> b)

Construct the combiner to consume the two given streams. The keys from the first Stream will be prefixed "a" and the second "b".

Parameters:

a - the first stream

b - the second stream

ContextStreamCombiner

public ContextStreamCombiner(Stream<Context> a,
                             Stream<Context> b,
                             String aprefix,
                             String bprefix)

Construct the combiner to consume the two given streams, using the given prefixes to modify the keys from the respective streams.

Parameters:

a - the first stream

b - the second stream

aprefix - the first stream key prefix

bprefix - the second stream key prefix

Method Detail

hasNext

public boolean hasNext()

next

public Context next()

combine

public static Stream<Context> combine(Stream<Context> a,
                                      Stream<Context> b)

Utility method to combine two streams. The keys from the first Stream will be prefixed "a" and the second "b".

Parameters:

a - the first stream

b - the second stream

Returns:

the combined stream