Package nz.org.riskscape.engine.join

Interface LopsidedJoiner<T>

All Superinterfaces:

AutoCloseable, Realized

public interface LopsidedJoiner<T>
extends Realized

A variation on Joiner that works by joining individual values from the lhs (left-hand side) to an indexed set of rhs (right-hand side) values. This API expects that the work of building the index be done for it in advance of being passed to join(Object, Tuple)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LHS_STEP_INDEX
static final int	RHS_STEP_INDEX

Method Summary

Modifier and Type	Method	Description
void	addToRhsIndex(Tuple rhs, T index)	Accumulate a rhs value in to the index
T	createRhsIndex()
default Struct	getJoinedType()	Deprecated. use getProducedType()
Struct	getLhs()	Expected type of the lhs of this join
Struct	getProducedType()	The type of tuple that join(Object, Tuple) produces.
Struct	getRhs()	Expected type of the rhs of this join
TupleIterator	join(T index, Tuple lhs)	Join a single lhs value to the indexed set of rhs values.

Methods inherited from interface nz.org.riskscape.engine.pipeline.Realized

close

Field Details

LHS_STEP_INDEX

static final int LHS_STEP_INDEX

See Also:

• Constant Field Values

RHS_STEP_INDEX

static final int RHS_STEP_INDEX

See Also:

• Constant Field Values

Method Details

getLhs

Struct getLhs()

Expected type of the lhs of this join

getRhs

Struct getRhs()

Expected type of the rhs of this join

getProducedType

Struct getProducedType()

The type of tuple that join(Object, Tuple) produces.

Specified by:

getProducedType in interface Realized

getJoinedType

@Deprecated
default Struct getJoinedType()

Deprecated.

use getProducedType()

createRhsIndex

T createRhsIndex()

Returns:

a new, empty index, for use with addToRhsIndex(Tuple, Object)

addToRhsIndex

void addToRhsIndex(Tuple rhs,
 T index)

Accumulate a rhs value in to the index

join

TupleIterator join(T index,
 Tuple lhs)

Join a single lhs value to the indexed set of rhs values. Implementations should use TupleIterator.EMPTY and Singleton where possible to take advantage of various optimisations in pipeline execution.