org.infinispan.commands.read

Class MapCombineCommand<KIn,VIn,KOut,VOut>

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.read.MapCombineCommand<KIn,VIn,KOut,VOut>

All Implemented Interfaces:

CancellableCommand, CacheRpcCommand, ReplicableCommand

public class MapCombineCommand<KIn,VIn,KOut,VOut>
extends BaseRpcCommand
implements CancellableCommand

MapCombineCommand is a container to migrate Mapper and Reducer which is a combiner to a remote Infinispan node where it will get executed and return the result to an invoking/master node.

Since:

5.0

Author:

Vladimir Blagojevic

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID

Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand

cacheName

Constructor Summary

Constructors

Constructor and Description
MapCombineCommand()
MapCombineCommand(String cacheName)
MapCombineCommand(String taskId, Mapper<KIn,VIn,KOut,VOut> mapper, Reducer<KOut,VOut> combiner, String cacheName, Collection<KIn> inputKeys)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
boolean	equals(Object obj)
Reducer<KOut,VOut>	getCombiner()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Set<KIn>	getKeys()
Mapper<KIn,VIn,KOut,VOut>	getMapper()
Object[]	getParameters() Used by marshallers to stream this command across a network
String	getTaskId()
UUID	getUUID() Returns UUID of a command
int	hashCode()
void	init(MapReduceManager mrManager)
boolean	isEmitCompositeIntermediateKeys()
boolean	isReducePhaseDistributed()
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext context) Performs invocation of mapping phase and local combine phase on assigned Infinispan node
void	setEmitCompositeIntermediateKeys(boolean emitCompositeIntermediateKeys)
void	setParameters(int commandId, Object[] args) Used by the CommandsFactory to create a command from raw data read off a stream.
void	setReducePhaseDistributed(boolean reducePhaseDistributed)
String	toString()

Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commands.remote.CacheRpcCommand

getCacheName, getOrigin, setOrigin

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

MapCombineCommand

public MapCombineCommand()

MapCombineCommand

public MapCombineCommand(String cacheName)

MapCombineCommand

public MapCombineCommand(String taskId,
                 Mapper<KIn,VIn,KOut,VOut> mapper,
                 Reducer<KOut,VOut> combiner,
                 String cacheName,
                 Collection<KIn> inputKeys)

Method Detail

init

public void init(MapReduceManager mrManager)

perform

public Object perform(InvocationContext context)
               throws Throwable

Performs invocation of mapping phase and local combine phase on assigned Infinispan node

Specified by:

perform in interface ReplicableCommand

Parameters:

context - invocation context

Returns:

Map of intermediate key value pairs

Throws:

Throwable - in the event of problems.

isEmitCompositeIntermediateKeys

public boolean isEmitCompositeIntermediateKeys()

setEmitCompositeIntermediateKeys

public void setEmitCompositeIntermediateKeys(boolean emitCompositeIntermediateKeys)

isReducePhaseDistributed

public boolean isReducePhaseDistributed()

setReducePhaseDistributed

public void setReducePhaseDistributed(boolean reducePhaseDistributed)

getKeys

public Set<KIn> getKeys()

getMapper

public Mapper<KIn,VIn,KOut,VOut> getMapper()

getCombiner

public Reducer<KOut,VOut> getCombiner()

getTaskId

public String getTaskId()

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Specified by:

getCommandId in interface ReplicableCommand

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

getUUID

public UUID getUUID()

Description copied from interface: CancellableCommand

Returns UUID of a command

Specified by:

getUUID in interface CancellableCommand

Returns:

command UUID

getParameters

public Object[] getParameters()

Description copied from interface: ReplicableCommand

Used by marshallers to stream this command across a network

Specified by:

getParameters in interface ReplicableCommand

Returns:

an object array of arguments, compatible with pre-2.2.0 MethodCall args.

setParameters

public void setParameters(int commandId,
                 Object[] args)

Description copied from interface: ReplicableCommand

Used by the CommandsFactory to create a command from raw data read off a stream.

Specified by:

setParameters in interface ReplicableCommand

Parameters:

commandId - command id to set. This is usually unused but *could* be used in the event of a command having multiple IDs, such as PutKeyValueCommand.

args - object array of args

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

canBlock

public boolean canBlock()

Description copied from interface: ReplicableCommand

If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread.

This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.

Specified by:

canBlock in interface ReplicableCommand

Overrides:

canBlock in class BaseRpcCommand

Returns:

true if the command can block/wait, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class BaseRpcCommand