cascading.operation.filter
Class Limit

java.lang.Object
  cascading.operation.BaseOperation<Limit.Context>
      cascading.operation.filter.Limit

All Implemented Interfaces:

Filter<Limit.Context>, Operation<Limit.Context>, Serializable

public class Limit
extends BaseOperation<Limit.Context>
implements Filter<Limit.Context>

Class Limit is a Filter that will limit the number of Tuple instances that it will allow to pass.

See Also:

Sample, Serialized Form

Nested Class Summary

static class

Limit.Context

Field Summary

Fields inherited from class cascading.operation.BaseOperation

fieldDeclaration, numArgs, trace

Fields inherited from interface cascading.operation.Operation

ANY

Constructor Summary

Limit(long limit)
Creates a new Limit class that only allows limit number of Tuple instances to pass.

Method Summary

boolean	isRemove(FlowProcess flowProcess, FilterCall<Limit.Context> filterCall) Method isRemove returns true if input should be removed from the tuple stream.
void	prepare(FlowProcess flowProcess, OperationCall<Limit.Context> operationCall) Method prepare does nothing, and may safely be overridden.

Methods inherited from class cascading.operation.BaseOperation

cleanup, getFieldDeclaration, getNumArgs, getTrace, printOperationInternal, toString, toStringInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface cascading.operation.Operation

cleanup, getFieldDeclaration, getNumArgs

Constructor Detail

Limit

public Limit(long limit)

Creates a new Limit class that only allows limit number of Tuple instances to pass.

Parameters:

limit - the number of tuples to let pass

Method Detail

prepare

public void prepare(FlowProcess flowProcess,
                    OperationCall<Limit.Context> operationCall)

Description copied from class: BaseOperation

Method prepare does nothing, and may safely be overridden.

Specified by:

prepare in interface Operation<Limit.Context>

Overrides:

prepare in class BaseOperation<Limit.Context>

isRemove

public boolean isRemove(FlowProcess flowProcess,
                        FilterCall<Limit.Context> filterCall)

Description copied from interface: Filter

Method isRemove returns true if input should be removed from the tuple stream.

Specified by:

isRemove in interface Filter<Limit.Context>

Parameters:

flowProcess - of type FlowProcess

filterCall - of type FilterCall

Returns:

boolean