AbstractDistributedTask

java.lang.Object
- com.graphdbapi.task.template.AbstractDistributedTask<RESULT>

All Implemented Interfaces:

ITask<RESULT>
```
public abstract class AbstractDistributedTask<RESULT>
extends java.lang.Object
implements ITask<RESULT>
```
功能描述： AbstractDistributedTask(ADT) 为分布式计算框架，采用bsp的设计思想，具备迭代的特性功能: 1. ADT框架封装了常用的方法，方便使用者调用 2. ADT框架封装了消息读写方式，使用者只需设置读写对象即可 3. ADT框架的release方法用于释放变量
备注： 1. 消息传输目前只支持基础数据类型，并且采用数组进行发送 2. 使用者如果觉得框架不方便可以自行封装

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Set<java.lang.Integer>`	`clusterNodeIds`
`protected int`	`currentDepth`
`protected java.util.concurrent.ExecutorService`	`executorService`
`protected java.util.List<java.util.concurrent.Future<?>>`	`futures`
`protected Graph`	`graph`
`protected LoggerUtil`	`graphLogger`
`protected IdsMap`	`idsMap`
`protected boolean`	`isStop`
`protected java.util.concurrent.CountDownLatch`	`latchDepth`
`protected int`	`limit`
`protected int`	`localClusterNodeId`
`protected int`	`localEndSeqId`
`protected int`	`localPartSize`
`protected int`	`localStartSeqId`
`protected IMessageHandler`	`messageUtil`
`protected int`	`partSize`
`protected int`	`sourceClusterNodeId`
`TaskStage`	`stage`
`protected TaskHandler`	`taskHandler`
`protected long`	`taskId`

Constructor Summary

Constructors
Constructor and Description
`AbstractDistributedTask(java.lang.String taskName, Graph graph, GraphLogger graphLogger, int sourceClusterNodeId, int maxIterations)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkParam(int iterations)` 检查迭代轮数是否合法迭代需要 >= 1
`boolean`	`distributed()` 是否为分布式任务.
`void`	`firstRound()` 初始化轮
`abstract void`	`firstRoundContext()` 第一轮消息发送的方法
`Graph`	`getGraph()` 获取图对象.
`int`	`getLimit()` 返回结果限制
`int`	`getLocalClusterNodeId()`
`LoggerUtil`	`getLogger()` 获取计算框架写日志对象.
`ArrayMessage`	`getMessage()`
`int`	`getSourceClusterNodeId()`
`boolean`	`getStop()` 获取计算框架停止值.
`long`	`getTaskId()` 获取任务号.
`java.lang.String`	`getTaskName()` 返回任务名.
`TaskStage`	`getTaskStage()` 获取任务状态.
`abstract void`	`init()` 变量相关的初始化方法
`void`	`isRunningOrThrow()` 停止异常
`void`	`nextRound(int depth)` 下一轮计算
`abstract void`	`nextRoundContext(int depth)` 后续轮算法实现
`protected void`	`parallelExecute(java.util.List<java.util.concurrent.Future<?>> futures)` 获取并行执行的任务
`abstract void`	`release()` 释放申请的变量内存
`abstract RESULT`	`result(int limit)` 返回结果
`void`	`setDepth(int depth)` 设置当前深度
`void`	`setLatchDepth(java.util.concurrent.CountDownLatch countDownLatch)` 设置当前轮
`ArrayMessage`	`setMessage(java.lang.Object sendValues, java.lang.Object receiveValues)` 设置消息发送对象根据用户传入的特定类型生成对应的消息处理器目前支持基础数据类型 int、double、long和float
`abstract ArrayMessage`	`setMessageObject()` 设置消息发送对象
`void`	`setStop()` 设置算法任务停止

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - latchDepth
```
protected java.util.concurrent.CountDownLatch latchDepth
```
  - stage
```
public TaskStage stage
```
  - taskId
```
protected long taskId
```
  - graph
```
protected Graph graph
```
  - sourceClusterNodeId
```
protected final int sourceClusterNodeId
```
  - messageUtil
```
protected IMessageHandler messageUtil
```
  - graphLogger
```
protected final LoggerUtil graphLogger
```
  - taskHandler
```
protected final TaskHandler taskHandler
```
  - localClusterNodeId
```
protected final int localClusterNodeId
```
  - localStartSeqId
```
protected final int localStartSeqId
```
  - localEndSeqId
```
protected final int localEndSeqId
```
  - localPartSize
```
protected int localPartSize
```
  - partSize
```
protected final int partSize
```
  - limit
```
protected int limit
```
  - executorService
```
protected java.util.concurrent.ExecutorService executorService
```
  - futures
```
protected java.util.List<java.util.concurrent.Future<?>> futures
```
  - clusterNodeIds
```
public final java.util.Set<java.lang.Integer> clusterNodeIds
```
  - idsMap
```
protected final IdsMap idsMap
```
  - currentDepth
```
protected int currentDepth
```
  - isStop
```
protected boolean isStop
```
- Constructor Detail
  - AbstractDistributedTask
```
public AbstractDistributedTask(java.lang.String taskName,
                               Graph graph,
                               GraphLogger graphLogger,
                               int sourceClusterNodeId,
                               int maxIterations)
```
- Method Detail
  - isRunningOrThrow
```
public void isRunningOrThrow()
```
    停止异常
  - setDepth
```
public final void setDepth(int depth)
```
    设置当前深度
    
    Parameters:
    
    depth - 深度
  - nextRound
```
public final void nextRound(int depth)
```
    下一轮计算
    
    Parameters:
    
    depth - 深度
  - firstRound
```
public final void firstRound()
```
    初始化轮
  - init
```
public abstract void init()
```
    变量相关的初始化方法
    
    Specified by:
    
    init in interface ITask<RESULT>
  - firstRoundContext
```
public abstract void firstRoundContext()
```
    第一轮消息发送的方法
  - nextRoundContext
```
public abstract void nextRoundContext(int depth)
```
    后续轮算法实现
    
    Parameters:
    
    depth - 深度
  - setMessageObject
```
public abstract ArrayMessage setMessageObject()
```
    设置消息发送对象
  - result
```
public abstract RESULT result(int limit)
```
    返回结果
    
    Specified by:
    
    result in interface ITask<RESULT>
    
    Parameters:
    
    limit - 返回limit限制
    
    Returns:
    
    返回结果
  - release
```
public abstract void release()
```
    释放申请的变量内存
    
    Specified by:
    
    release in interface ITask<RESULT>
  - setMessage
```
public final ArrayMessage setMessage(java.lang.Object sendValues,
                                     java.lang.Object receiveValues)
```
    设置消息发送对象根据用户传入的特定类型生成对应的消息处理器目前支持基础数据类型 int、double、long和float
    
    Parameters:
    
    sendValues - 发送对象
    
    receiveValues - 接受对象
  - getTaskName
```
public java.lang.String getTaskName()
```
    Description copied from interface: ITask
    
    返回任务名.
    
    Specified by:
    
    getTaskName in interface ITask<RESULT>
    
    Returns:
    
    任务名.
  - getTaskId
```
public long getTaskId()
```
    Description copied from interface: ITask
    
    获取任务号.
    
    Specified by:
    
    getTaskId in interface ITask<RESULT>
    
    Returns:
    
    任务号.
  - getLogger
```
public LoggerUtil getLogger()
```
    Description copied from interface: ITask
    
    获取计算框架写日志对象.
    
    Specified by:
    
    getLogger in interface ITask<RESULT>
    
    Returns:
    
    日志对象.
  - setStop
```
public final void setStop()
```
    Description copied from interface: ITask
    
    设置算法任务停止
    
    Specified by:
    
    setStop in interface ITask<RESULT>
  - getStop
```
public final boolean getStop()
```
    Description copied from interface: ITask
    
    获取计算框架停止值.
    
    Specified by:
    
    getStop in interface ITask<RESULT>
    
    Returns:
    
    计算框架停止值.
  - getTaskStage
```
public TaskStage getTaskStage()
```
    Description copied from interface: ITask
    
    获取任务状态.
    
    Specified by:
    
    getTaskStage in interface ITask<RESULT>
    
    Returns:
    
    任务状态.
  - getLocalClusterNodeId
```
public int getLocalClusterNodeId()
```
  - getGraph
```
public Graph getGraph()
```
    Description copied from interface: ITask
    
    获取图对象.
    
    Specified by:
    
    getGraph in interface ITask<RESULT>
    
    Returns:
    
    获取Graph
  - distributed
```
public final boolean distributed()
```
    Description copied from interface: ITask
    
    是否为分布式任务.
    
    Specified by:
    
    distributed in interface ITask<RESULT>
    
    Returns:
    
    分布式标识
  - parallelExecute
```
protected void parallelExecute(java.util.List<java.util.concurrent.Future<?>> futures)
```
    获取并行执行的任务
    
    Parameters:
    
    futures - call任务集合
  - getSourceClusterNodeId
```
public int getSourceClusterNodeId()
```
    Returns:
    
    获取请求机器id
  - checkParam
```
protected void checkParam(int iterations)
```
    检查迭代轮数是否合法迭代需要 >= 1
    
    Parameters:
    
    iterations - 迭代轮数
  - getMessage
```
public ArrayMessage getMessage()
```
    Returns:
    
    获取消息对象
  - setLatchDepth
```
public final void setLatchDepth(java.util.concurrent.CountDownLatch countDownLatch)
```
    设置当前轮
    
    Parameters:
    
    countDownLatch - 迭代轮
  - getLimit
```
public final int getLimit()
```
    返回结果限制
    
    Returns:
    
    结果输了上限

Class AbstractDistributedTask<RESULT>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

latchDepth

stage

taskId

graph

sourceClusterNodeId

messageUtil

graphLogger

taskHandler

localClusterNodeId

localStartSeqId

localEndSeqId

localPartSize

partSize

limit

executorService

futures

clusterNodeIds

idsMap

currentDepth

isStop

Constructor Detail

AbstractDistributedTask

Method Detail

isRunningOrThrow

setDepth

nextRound

firstRound

init

firstRoundContext

nextRoundContext

setMessageObject

result

release

setMessage

getTaskName

getTaskId

getLogger

setStop

getStop

getTaskStage

getLocalClusterNodeId

getGraph

distributed

parallelExecute

getSourceClusterNodeId

checkParam

getMessage

setLatchDepth

getLimit