org.gridgain.grid
Class GridTaskSplitAdapter<T,R>

java.lang.Object
  org.gridgain.grid.GridTaskAdapter<T,R>
      org.gridgain.grid.GridTaskSplitAdapter<T,R>

Type Parameters:

T - Type of the task execution argument passed as a 2nd argument into Grid.execute(Class, Object) method.

R - Type of the task result returning from GridTask.reduce(List) method.

All Implemented Interfaces:

Serializable, GridTask<T,R>

Direct Known Subclasses:

GridifyTaskSplitAdapter

public abstract class GridTaskSplitAdapter<T,R>
extends GridTaskAdapter<T,R>

This class defines simplified adapter for GridTask. This adapter can be used when jobs can be randomly assigned to available grid nodes. This adapter is sufficient in most homogeneous environments where all nodes are equally suitable for executing grid job. See GridTaskSplitAdapter.split(int, Object) method for more details.

Below is a coding example of how you would use GridTaskSplitAdapter:

 public class MyFooBarTask extends GridTaskSplitAdapter<Object, String> {
     @Override
     protected Collection<? extends GridJob> split(int gridSize, Object arg) throws GridException {
         List<MyFooBarJob> jobs = new ArrayList<MyFooBarJob>(gridSize);
 
         for (int i = 0; i < gridSize; i++) {
             jobs.add(new MyFooBarJob(arg));
         }
 
         // Node assignment via load balancer 
         // happens automatically.
         return jobs;
     }
 
     // Aggregate results into one compound result.
     public String reduce(List<GridJobResult> results) throws GridException {
         // For the purpose of this example we simply
         // concatenate string representation of every 
         // job result
         StringBuilder buf = new StringBuilder();
 
         for (GridJobResult res : results) {
             // Append string representation of result
             // returned by every job.
             buf.append(res.getData().toString());
         }
 
         return buf.toString();
     }
 } 
 

Migrating to GridGain 2.0

In GridGain 2.0 this interface API has been updated for better static type checking. Although the change is trivial and provides much better type safety during development - it introduced incompatibility with prior versions of GridGain. Follow this link for easy source code migration instructions.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

See Also:

Serialized Form

Constructor Summary

GridTaskSplitAdapter()

Method Summary

Map<? extends GridJob,GridNode>	map(List<GridNode> subgrid, T arg) This method is called to map or split grid task into multiple grid jobs.
protected abstract Collection<? extends GridJob>	split(int gridSize, T arg) This is a simplified version of GridTask.map(List, Object) method.

Methods inherited from class org.gridgain.grid.GridTaskAdapter

result

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.GridTask

reduce

Constructor Detail

GridTaskSplitAdapter

public GridTaskSplitAdapter()

Method Detail

split

protected abstract Collection<? extends GridJob> split(int gridSize,
                                                       T arg)
                                                throws GridException

This is a simplified version of GridTask.map(List, Object) method.

This method basically takes given argument and splits it into a collection of GridJob using provided grid size as indication of how many node are available.

Throws:

GridException - Thrown in case of any errors.

Parameters:

gridSize - Number of available grid nodes. Note that returned number of jobs can be less, equal or greater than this grid size.

arg - Task execution argument. Can be null.

Returns:

Collection of grid jobs. These jobs will be randomly mapped to available grid nodes. Note that if number of jobs is greater than number of grid nodes (i.e, grid size), the grid nodes will be reused and some jobs will end up on the same grid nodes.

See Also:

GridTask.map(List, Object)

map

public final Map<? extends GridJob,GridNode> map(List<GridNode> subgrid,
                                                 T arg)
                                          throws GridException

This method is called to map or split grid task into multiple grid jobs. This is the first method that gets called when task execution starts.

Throws:

GridException - If mapping could not complete successfully. This exception will be thrown out of GridTaskFuture.get() method.

Parameters:

subgrid - Nodes available for this task execution. Note that order of nodes is guaranteed to be randomized by container. This ensures that every time you simply iterate through grid nodes, the order of nodes will be random which over time should result into all nodes being used equally.

arg - Task execution argument. Can be null. This is the same argument as the one passed into Grid.execute(GridTask, Object) method (or any of the other Grid.execute(...) methods.

Returns:

Map of grid jobs assigned to subgrid node. If null or empty list is returned, exception will be thrown.