org.apache.flink.graph.drivers.transform

Interface Transform<II,IO,RI,RO>

Type Parameters:

II - input transformation input type

IO - input transformation output type

RI - result transformation input type

RO - input transformation output type

All Superinterfaces:

Parameterized

All Known Implementing Classes:

GraphKeyTypeTransform

public interface Transform<II,IO,RI,RO>
extends Parameterized

A transform is executed both before and after algorithm execution. Multiple transforms may be applied and the order of execution is as listed by the input then algorithm components. The input is transformed in given order and the algorithm result is transformed in reverse order.

Method Summary

Modifier and Type	Method and Description
String	getIdentity() A human-readable identifier summarizing the transform and configuration.
IO	transformInput(II input) Apply the forward transformation to the input graph.
RO	transformResult(RI result) Apply the reverse transformation to the algorithm result.

Methods inherited from interface org.apache.flink.graph.drivers.parameter.Parameterized

configure, getName, getUsage

Method Detail

getIdentity

String getIdentity()

A human-readable identifier summarizing the transform and configuration.

Returns:

the transform identifier

transformInput

IO transformInput(II input)
           throws Exception

Apply the forward transformation to the input graph.

Parameters:

input - transformation input

Returns:

transformation output

Throws:

Exception

transformResult

RO transformResult(RI result)
            throws Exception

Apply the reverse transformation to the algorithm result.

Parameters:

result - transformation input

Returns:

transformation output

Throws:

Exception