com.hazelcast.client.impl.protocol.template

Interface MapReduceCodecTemplate

public interface MapReduceCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	cancel(String name, String jobId)
Object	forCustom(String name, String jobId, Data predicate, Data mapper, Data combinerFactory, Data reducerFactory, Data keyValueSource, int chunkSize, List<Data> keys, String topologyChangedStrategy)
Object	forList(String name, String jobId, Data predicate, Data mapper, Data combinerFactory, Data reducerFactory, String listName, int chunkSize, List<Data> keys, String topologyChangedStrategy)
Object	forMap(String name, String jobId, Data predicate, Data mapper, Data combinerFactory, Data reducerFactory, String mapName, int chunkSize, List<Data> keys, String topologyChangedStrategy)
Object	forMultiMap(String name, String jobId, Data predicate, Data mapper, Data combinerFactory, Data reducerFactory, String multiMapName, int chunkSize, List<Data> keys, String topologyChangedStrategy)
Object	forSet(String name, String jobId, Data predicate, Data mapper, Data combinerFactory, Data reducerFactory, String setName, int chunkSize, List<Data> keys, String topologyChangedStrategy)
Object	jobProcessInformation(String name, String jobId)

Method Detail

cancel

Object cancel(String name,
            String jobId)

Parameters:

name - Name of the distributed object

jobId - Id of the job to cancel

Returns:

Returns true if successful, false otherwise

jobProcessInformation

Object jobProcessInformation(String name,
                           String jobId)

Parameters:

name - Name of the distributed object

jobId - Id of the job

Returns:

The information about the job if exists

forMap

Object forMap(String name,
            String jobId,
            @Nullable
            Data predicate,
            Data mapper,
            @Nullable
            Data combinerFactory,
            @Nullable
            Data reducerFactory,
            String mapName,
            int chunkSize,
            @Nullable
            List<Data> keys,
            @Nullable
            String topologyChangedStrategy)

Parameters:

name - Name of the distributed object

jobId - Id of the job

predicate - The filter to use during operation

mapper - The mapper for the operation

combinerFactory - The combiner factory to use

reducerFactory - The reducer factory to be used

mapName - Name of the Map object to work on.

chunkSize - The number of items for which the reduce shall be performed

keys - The keys for the objects to be processed

topologyChangedStrategy - The strategy to use if a topology change is detected.

Returns:

The resulting key-value pairs.

forList

Object forList(String name,
             String jobId,
             @Nullable
             Data predicate,
             Data mapper,
             @Nullable
             Data combinerFactory,
             @Nullable
             Data reducerFactory,
             String listName,
             int chunkSize,
             @Nullable
             List<Data> keys,
             @Nullable
             String topologyChangedStrategy)

Parameters:

name - Name of the distributed object

jobId - Id of the job

predicate - The filter to use during operation

mapper - The mapper for the operation

combinerFactory - The combiner factory to use

reducerFactory - The reducer factory to be used

listName - Name of the List object to work on.

chunkSize - The number of items for which the reduce shall be performed

keys - The keys for the objects to be processed

topologyChangedStrategy - The strategy to use if a topology change is detected.

Returns:

The resulting key-value pairs.

forSet

Object forSet(String name,
            String jobId,
            @Nullable
            Data predicate,
            Data mapper,
            @Nullable
            Data combinerFactory,
            @Nullable
            Data reducerFactory,
            String setName,
            int chunkSize,
            @Nullable
            List<Data> keys,
            @Nullable
            String topologyChangedStrategy)

Parameters:

name - Name of the distributed object

jobId - Id of the job

predicate - The filter to use during operation

mapper - The mapper for the operation

combinerFactory - The combiner factory to use

reducerFactory - The reducer factory to be used

setName - Name of the Set object to work on.

chunkSize - The number of items for which the reduce shall be performed

keys - The keys for the objects to be processed

topologyChangedStrategy - The strategy to use if a topology change is detected.

Returns:

The resulting key-value pairs.

forMultiMap

Object forMultiMap(String name,
                 String jobId,
                 @Nullable
                 Data predicate,
                 Data mapper,
                 @Nullable
                 Data combinerFactory,
                 @Nullable
                 Data reducerFactory,
                 String multiMapName,
                 int chunkSize,
                 @Nullable
                 List<Data> keys,
                 @Nullable
                 String topologyChangedStrategy)

Parameters:

name - Name of the distributed object

jobId - Id of the job

predicate - The filter to use during operation

mapper - The mapper for the operation

combinerFactory - The combiner factory to use

reducerFactory - The reducer factory to be used

multiMapName - Name of the MultiMap object to work on.

chunkSize - The number of items for which the reduce shall be performed

keys - The keys for the objects to be processed

topologyChangedStrategy - The strategy to use if a topology change is detected.

Returns:

The resulting key-value pairs.

forCustom

Object forCustom(String name,
               String jobId,
               @Nullable
               Data predicate,
               Data mapper,
               @Nullable
               Data combinerFactory,
               @Nullable
               Data reducerFactory,
               Data keyValueSource,
               int chunkSize,
               @Nullable
               List<Data> keys,
               @Nullable
               String topologyChangedStrategy)

Parameters:

name - Name of the distributed object

jobId - Id of the job

predicate - The filter to use during operation

mapper - The mapper for the operation

combinerFactory - The combiner factory to use

reducerFactory - The reducer factory to be used

keyValueSource - custom data sources for mapreduce algorithm. The object implements the com.hazelcast.mapreduce.KeyValueSource interface

chunkSize - The number of items for which the reduce shall be performed

keys - The keys for the objects to be processed

topologyChangedStrategy - The strategy to use if a topology change is detected.

Returns:

The resulting key-value pairs.