com.tagtraum.jipes.universal

Class Join<I,O>

java.lang.Object

com.tagtraum.jipes.universal.Join<I,O>

Type Parameters:

I - type of the input values

O - type of the output values

All Implemented Interfaces:

SignalProcessor<I,O>

Direct Known Subclasses:

InterleavedChannelJoin

public class Join<I,O>
extends Object
implements SignalProcessor<I,O>

Joins input data from N consecutive calls to process(Object) using an AggregateFunction. By adding this joiner to multiple SignalProcessors, which are children of the same SignalSplit, one can rejoin multiple bands, e.g. by adding their values.

Author:

Hendrik Schreiber

See Also:

SignalSplit

Constructor Summary

Constructors

Constructor and Description
Join(int partsPerUnit, AggregateFunction<List<I>,O> aggregateFunction)
Join(int partsPerUnit, AggregateFunction<List<I>,O> aggregateFunction, Object id)

Method Summary

Modifier and Type	Method and Description
<O2> SignalProcessor<O,O2>	connectTo(SignalProcessor<O,O2> signalProcessor) Connects this processor to another processor to forward processed data to.
<O2> SignalProcessor<O,O2>	disconnectFrom(SignalProcessor<O,O2> signalProcessor) Disconnects a child processor.
boolean	equals(Object o)
void	flush() Only flush, if we just aggregated some signal, but not, if we are still waiting for missing parts.
SignalProcessor<O,?>[]	getConnectedProcessors() Lists all connected processors.
Object	getId() By default this simply calls toString()
O	getOutput() First calls SignalProcessor.flush(), then returns the pending output, should there be any.
int	getPartsPerUnit()
int	hashCode()
void	process(I i) Only call kids process method, if we have enough parts.
void	setId(Object id) Let's you provide an id.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Join

public Join(int partsPerUnit,
            AggregateFunction<List<I>,O> aggregateFunction)

Join

public Join(int partsPerUnit,
            AggregateFunction<List<I>,O> aggregateFunction,
            Object id)

Method Detail

getPartsPerUnit

public int getPartsPerUnit()

process

public void process(I i)
             throws IOException

Only call kids process method, if we have enough parts.

Specified by:

process in interface SignalProcessor<I,O>

Parameters:

i - data to process

Throws:

IOException

See Also:

SignalProcessor.getConnectedProcessors()

flush

public void flush()
           throws IOException

Only flush, if we just aggregated some signal, but not, if we are still waiting for missing parts. Also, flush at most once. This effectively swallows flush calls, if they occur before we put all the pieces together. We do this to avoid pre-mature/multiple flushing.

Specified by:

flush in interface SignalProcessor<I,O>

Throws:

IOException

getOutput

public O getOutput()
            throws IOException

Description copied from interface: SignalProcessor

First calls SignalProcessor.flush(), then returns the pending output, should there be any. Note that this call may only succeed once to preserve memory.

Specified by:

getOutput in interface SignalProcessor<I,O>

Returns:

output, if available. If not, null is returned

Throws:

IOException - if a processing error occurs

getId

public Object getId()

By default this simply calls toString()

Specified by:

getId in interface SignalProcessor<I,O>

Returns:

id

See Also:

setId(Object)

setId

public void setId(Object id)

Let's you provide an id.

Parameters:

id - some identifier

connectTo

public <O2> SignalProcessor<O,O2> connectTo(SignalProcessor<O,O2> signalProcessor)

Description copied from interface: SignalProcessor

Connects this processor to another processor to forward processed data to. This method returns its parameter and therefore encourages method chaining to build processing chains/pipelines.

Specified by:

connectTo in interface SignalProcessor<I,O>

Type Parameters:

O2 - output type of the processor we want to connect to

Parameters:

signalProcessor - processor

Returns:

the just added processor

See Also:

SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.getConnectedProcessors(), SignalPipeline

disconnectFrom

public <O2> SignalProcessor<O,O2> disconnectFrom(SignalProcessor<O,O2> signalProcessor)

Description copied from interface: SignalProcessor

Disconnects a child processor.

Specified by:

disconnectFrom in interface SignalProcessor<I,O>

Type Parameters:

O2 - output type of the processor we want to disconnect from

Parameters:

signalProcessor - processor

Returns:

the processor, if it was indeed removed

See Also:

SignalProcessor.connectTo(SignalProcessor), SignalProcessor.getConnectedProcessors()

getConnectedProcessors

public SignalProcessor<O,?>[] getConnectedProcessors()

Description copied from interface: SignalProcessor

Lists all connected processors.

Specified by:

getConnectedProcessors in interface SignalProcessor<I,O>

Returns:

array of registered processors, never null

See Also:

SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.connectTo(SignalProcessor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object