groovyx.gpars.dataflow.operator
[Java] Class Pipeline

java.lang.Object
  groovyx.gpars.dataflow.operator.Pipeline

public final class Pipeline

A builder for operator pipelines. The greatest benefit of using the Pipeline class compared to chaining the channels directly is the ease with which a custom thread pool/group can be applied to all the operators along the constructed chain.

Authors:

Vaclav Pech

complete

private boolean complete

group

private final PGroup group

output

private DataflowReadChannel output

Pipeline

public Pipeline(DataflowReadChannel output)

Pipeline

public Pipeline(Pool pool, DataflowReadChannel output)

Pipeline

public Pipeline(PGroup group, DataflowReadChannel output)

binaryChoice

public void binaryChoice(DataflowWriteChannel trueBranch, DataflowWriteChannel falseBranch, groovy.lang.Closure code)

Directs the output to one of the two output channels depending on the boolean result of the provided closure.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

trueBranch - The channel to send data to if the closure returns true

falseBranch - The channel to send data to if the closure returns true

code - A closure directing data to either the true or the false output branch

binaryChoice

public void binaryChoice(java.util.Map params, DataflowWriteChannel trueBranch, DataflowWriteChannel falseBranch, groovy.lang.Closure code)

Directs the output to one of the output channels depending on the int result of the provided closure.

Parameters:

outputs - The channels to send data to.

code - A closure returning an index of the output channel to direct the data to

chainWith

public Pipeline chainWith(groovy.lang.Closure closure)

Creates and attaches a new operator

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

closure - The function to invoke on all incoming values as part of the new operator's body

- The type of values returned from the supplied closure

Returns:

This Pipeline instance

chainWith

public Pipeline chainWith(java.util.Map params, groovy.lang.Closure closure)

Creates and attaches a new operator

Parameters:

closure - The function to invoke on all incoming values as part of the new operator's body

- The type of values returned from the supplied closure

Returns:

This Pipeline instance

checkState

private void checkState()

choice

public void choice(java.util.List outputs, groovy.lang.Closure code)

Directs the output to one of the output channels depending on the int result of the provided closure.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

outputs - The channels to send data to.

code - A closure returning an index of the output channel to direct the data to

choice

public void choice(java.util.Map params, java.util.List outputs, groovy.lang.Closure code)

Allows the closure to output different values to different output channels.

Parameters:

outputs - The channels to send data to.

code - A closure returning a list of values to pass to the output channels. Values are output to the output channels with identical index.

filter

public Pipeline filter(groovy.lang.Closure closure)

Creates and attaches a new operator that will filter data using the provided closure

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

closure - The filter function to invoke on all incoming values to decide whether to pass the value on or not

Returns:

This Pipeline instance

filter

public Pipeline filter(java.util.Map params, groovy.lang.Closure closure)

Makes the output of the pipeline to be an input for the specified channel

Parameters:

target - The channel to copy data into

- The type of values passed between the channels

getGroup

public PGroup getGroup()

getOutput

public DataflowReadChannel getOutput()

into

public void into(DataflowWriteChannel target)

Makes the output of the pipeline to be an input for the specified channel

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

target - The channel to copy data into

- The type of values passed between the channels

into

public void into(java.util.Map params, DataflowWriteChannel target)

Makes the output of the pipeline to be an input for the specified channel

Parameters:

target - The channel to copy data into

- The type of values passed between the channels

isComplete

public boolean isComplete()

merge

Pipeline merge(DataflowReadChannel other, groovy.lang.Closure closure)

Merges channels together as inputs for a single dataflow operator.

Parameters:

others - The channels to merge with

closure - The function to invoke on all incoming values as part of the new operator's body. The number of arguments to the closure must match the number of input channels.

Returns:

A channel of the same type as this channel, which the new operator will output into.

merge

Pipeline merge(java.util.List others, groovy.lang.Closure closure)

Merges channels together as inputs for a single dataflow operator.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

other - The channel to merge with

closure - The function to invoke on all incoming values as part of the new operator's body. The number of arguments to the closure must match the number of input channels.

Returns:

A channel of the same type as this channel, which the new operator will output into.

merge

Pipeline merge(java.util.Map params, DataflowReadChannel other, groovy.lang.Closure closure)

Merges channels together as inputs for a single dataflow operator.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

others - The channels to merge with

closure - The function to invoke on all incoming values as part of the new operator's body. The number of arguments to the closure must match the number of input channels.

Returns:

A channel of the same type as this channel, which the new operator will output into.

merge

Pipeline merge(java.util.Map params, java.util.List others, groovy.lang.Closure closure)

Directs the output to one of the two output channels depending on the boolean result of the provided closure.

Parameters:

trueBranch - The channel to send data to if the closure returns true

falseBranch - The channel to send data to if the closure returns true

code - A closure directing data to either the true or the false output branch

or

public Pipeline or(groovy.lang.Closure closure)

Creates and attaches a new operator that will filter data using the provided closure

Parameters:

closure - The filter function to invoke on all incoming values to decide whether to pass the value on or not

Returns:

This Pipeline instance

or

public void or(DataflowWriteChannel target)

Splits the output of the pipeline to be an input for the specified channels

Parameters:

target1 - The first channel to copy data into

target2 - The second channel to copy data into

- The type of values passed between the channels

separate

public void separate(java.util.List outputs, groovy.lang.Closure code)

Allows the closure to output different values to different output channels.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

outputs - The channels to send data to.

code - A closure returning a list of values to pass to the output channels. Values are output to the output channels with identical index.

separate

public void separate(java.util.Map params, java.util.List outputs, groovy.lang.Closure code)

split

public void split(DataflowWriteChannel target1, DataflowWriteChannel target2)

Makes the output of the pipeline to be an input for the specified channels

Parameters:

targets - The channels to copy data into

- The type of values passed between the channels

split

public void split(java.util.List targets)

Splits the output of the pipeline to be an input for the specified channels

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

target1 - The first channel to copy data into

target2 - The second channel to copy data into

- The type of values passed between the channels

split

public void split(java.util.Map params, DataflowWriteChannel target1, DataflowWriteChannel target2)

Makes the output of the pipeline to be an input for the specified channels

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

targets - The channels to copy data into

- The type of values passed between the channels

split

public void split(java.util.Map params, java.util.List targets)

Taps into the pipeline at the current position, sending all data that pass through the pipeline also to the channel specified.

Parameters:

target - The channel to tap data into

- The type of values passed between the channels

Returns:

This Pipeline instance

tap

public Pipeline tap(DataflowWriteChannel target)

Taps into the pipeline at the current position, sending all data that pass through the pipeline also to the channel specified.

Parameters:

params - Additional parameters to initialize the operator with (e.g. listeners or maxForks)

target - The channel to tap data into

- The type of values passed between the channels

Returns:

This Pipeline instance

tap

public Pipeline tap(java.util.Map params, DataflowWriteChannel target)

Merges channels together as inputs for a single dataflow operator.

Parameters:

other - The channel to merge with

closure - The function to invoke on all incoming values as part of the new operator's body. The number of arguments to the closure must match the number of input channels.

Returns:

A channel of the same type as this channel, which the new operator will output into.

Copyright © 2008–2013 Václav Pech. All Rights Reserved.