eu.stratosphere.arraymodel.functions

Class CrossFunction

java.lang.Object

eu.stratosphere.api.common.functions.AbstractFunction

eu.stratosphere.arraymodel.functions.AbstractArrayModelFunction

eu.stratosphere.arraymodel.functions.CrossFunction

All Implemented Interfaces:

Function, GenericCrosser<Value[],Value[],Value[]>

public abstract class CrossFunction
extends AbstractArrayModelFunction
implements GenericCrosser<Value[],Value[],Value[]>

The CrossFunction must be extended to provide a cross implementation which is called by a Cross PACT. By definition, a Cross PACT has two input sets of records. It calls the cross implementation for each element of the Cartesian product of both input sets. For details on the Cross PACT read the documentation of the PACT programming model.

For a cross implementation, the cross() method must be implemented.

Constructor Summary

Constructors

Constructor and Description
CrossFunction()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	cross(Value[] record1, Value[] record2, Collector<Value[]> out) This method must be implemented to provide a user implementation of a cross.
Method	getUDFMethod()

Methods inherited from class eu.stratosphere.arraymodel.functions.AbstractArrayModelFunction

getDataTypes

Methods inherited from class eu.stratosphere.api.common.functions.AbstractFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.stratosphere.api.common.functions.Function

close, getRuntimeContext, open, setRuntimeContext

Constructor Detail

CrossFunction

public CrossFunction()

Method Detail

cross

public abstract void cross(Value[] record1,
         Value[] record2,
         Collector<Value[]> out)

This method must be implemented to provide a user implementation of a cross. It is called for each element of the Cartesian product of both input sets.

Specified by:

cross in interface GenericCrosser<Value[],Value[],Value[]>

Parameters:

record1 - The record from the second input.

record2 - The record from the second input.

out - A collector that collects all output records.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

getUDFMethod

public Method getUDFMethod()

Specified by:

getUDFMethod in class AbstractArrayModelFunction