TaskHandler

```
public interface TaskHandler
```
图计算句柄, 包含多种图计算模式. 图计算引擎(Graph Calculation Engine): 一种使用内存加速图计算的功能. 图计算框架(Graph Calculation Framework): 一种封装了BSP(Bulk Synchronous Parallel)框架的功能.

Since:

3.4.4

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`ITask<?>`	`checkExecuteInfo(long taskId)` 检查任务释放存在(不报错).
`IdsMap`	`getIdsMap(java.util.Set<java.lang.Integer> vertexTypes)` 获取 IdsMap 对象.
`IMessageHandler`	`getMessageInstance(java.util.function.Supplier<java.lang.String> algorithm, long taskId, GraphLogger graphLogger, int clusterNodeId)` 获取消息处理实例.
`java.util.concurrent.ExecutorService`	`getOrCreateTaskPools()` 获取任务线程池对象.
`ITask<?>`	`getTask(long taskId)` 获取任务.
`boolean`	`hasStartup(java.lang.String engineName)` 图引擎是否已经启动完成.
`java.util.Map<java.lang.String,EngineStartupMeta>`	`listEngineGraph()` 列出所有的图引擎信息.
`void`	`remove(long taskId)` 移除任务.
`<RESULT> RESULT`	`submitDistributedTask(AbstractDistributedTask<RESULT> task)` 提交分布式图计算任务.
`<RESULT> RESULT`	`submitEngineBatchTask(java.lang.String engineName, EngineConfig startupConfig, EngineTaskCallable<RESULT> batchTask)` 提交图引擎批处理任务并返回结果, 如果未启动则按照启动配置进行启动.
`default <RESULT> RESULT`	`submitEngineBatchTask(java.lang.String engineName, EngineTaskCallable<RESULT> batchTask)` 提交图引擎批处理任务并返回结果, 如果未启动则抛出未启动异常.
`default void`	`submitEngineDropTask(java.lang.String engineName)` 提交图引擎关闭任务.
`void`	`submitEngineDropTask(java.lang.String engineName, boolean ignoreNotStartedError)` 提交图引擎关闭任务.
`default void`	`submitEngineStartupTask(java.lang.String engineName, EngineConfig startupConfig)` 提交图引擎启动任务, 如果未启动则按照启动配置进行启动, 如果已启动则抛出已启动异常.
`<RESULT> RESULT`	`submitEngineUnsafeBatchTask(java.lang.String engineName, EngineConfig startupConfig, com.graphdbapi.engine.unsafe.EngineTaskCallable<RESULT> batchTask)` Deprecated.
`<RESULT> RESULT`	`submitTask(AbstractStandAloneTask<RESULT> task)` 提交单机图计算任务.

- Method Detail
  - getIdsMap
```
IdsMap getIdsMap(java.util.Set<java.lang.Integer> vertexTypes)
```
    获取 IdsMap 对象.
    
    Parameters:
    
    vertexTypes - 点类型过滤.
    
    Returns:
    
    IdsMap 对象.
  - getOrCreateTaskPools
```
java.util.concurrent.ExecutorService getOrCreateTaskPools()
```
    获取任务线程池对象.
    
    Returns:
    
    返回任务线程池对象.
  - submitTask
```
<RESULT> RESULT submitTask(AbstractStandAloneTask<RESULT> task)
                    throws java.lang.Exception
```
    提交单机图计算任务.
    
    Type Parameters:
    
    RESULT - 设置结果形式
    
    Parameters:
    
    task - 提交单机任务
    
    Returns:
    
    返回计算结果.
    
    Throws:
    
    java.lang.Exception
  - submitDistributedTask
```
<RESULT> RESULT submitDistributedTask(AbstractDistributedTask<RESULT> task)
                               throws java.lang.Exception
```
    提交分布式图计算任务.
    
    Type Parameters:
    
    RESULT - 设置结果形式
    
    Parameters:
    
    task - 提交分布式任务
    
    Returns:
    
    返回计算结果.
    
    Throws:
    
    java.lang.Exception
  - getMessageInstance
```
IMessageHandler getMessageInstance(java.util.function.Supplier<java.lang.String> algorithm,
                                   long taskId,
                                   GraphLogger graphLogger,
                                   int clusterNodeId)
```
    获取消息处理实例.
    
    Parameters:
    
    algorithm - 传入算法
    
    taskId - 任务Id
    
    graphLogger - 日志
    
    clusterNodeId - 原主机
    
    Returns:
    
    消息处理实例
  - remove
```
void remove(long taskId)
```
    移除任务.
    
    Parameters:
    
    taskId - 任务标识
  - getTask
```
ITask<?> getTask(long taskId)
```
    获取任务.
    
    Parameters:
    
    taskId - 任务标识
  - checkExecuteInfo
```
ITask<?> checkExecuteInfo(long taskId)
```
    检查任务释放存在(不报错).
    
    Parameters:
    
    taskId - 任务标识
    
    Returns:
    
    返回任务.
  - submitEngineBatchTask
```
<RESULT> RESULT submitEngineBatchTask(java.lang.String engineName,
                                      EngineConfig startupConfig,
                                      EngineTaskCallable<RESULT> batchTask)
```
    提交图引擎批处理任务并返回结果, 如果未启动则按照启动配置进行启动.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    startupConfig - 图引擎启动配置, 如果图引擎已经启动则忽略该配置项, 否则使用该配置进行启动. 若填 null 则会检查图引擎是否启动, 如未启动则会抛出图引擎未启动异常.
    
    batchTask - 图引擎批处理任务, 在 call 方法通过对象 EngineGraph 对图引擎进行操作, call 方法调用结束后 EngineGraph 对象会被销毁. 若填 null 则不做批处理任务.
    
    Returns:
    
    图引擎批处理结果, 返回的结果为 call 方法 return 出的结果.
    
    Since:
    
    3.4.4
  - hasStartup
```
boolean hasStartup(java.lang.String engineName)
```
    图引擎是否已经启动完成.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    Returns:
    
    true 表示已经启动完成.
    
    Since:
    
    3.4.4
  - submitEngineStartupTask
```
default void submitEngineStartupTask(java.lang.String engineName,
                                     EngineConfig startupConfig)
```
    提交图引擎启动任务, 如果未启动则按照启动配置进行启动, 如果已启动则抛出已启动异常.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    startupConfig - 图引擎启动配置, 若填 null 则会使用默认配置 new EngineConfig() 进行启动.
    
    Throws:
    
    EngineApiException - 图引擎已经启动.
    
    Since:
    
    3.4.4
  - submitEngineBatchTask
```
default <RESULT> RESULT submitEngineBatchTask(java.lang.String engineName,
                                              EngineTaskCallable<RESULT> batchTask)
```
    提交图引擎批处理任务并返回结果, 如果未启动则抛出未启动异常.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    batchTask - 图引擎批处理任务, 在 call 方法通过对象 EngineGraph 对图引擎进行操作, call 方法调用结束后 EngineGraph 对象会被销毁. 若填 null 则不做批处理任务.
    
    Returns:
    
    图引擎批处理结果, 返回的结果为 call 方法 return 出的结果.
    
    Since:
    
    3.4.4
  - submitEngineDropTask
```
default void submitEngineDropTask(java.lang.String engineName)
```
    提交图引擎关闭任务.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    Since:
    
    3.4.4
  - submitEngineDropTask
```
void submitEngineDropTask(java.lang.String engineName,
                          boolean ignoreNotStartedError)
```
    提交图引擎关闭任务.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    ignoreNotStartedError - true表示忽略图引擎未启动的错误。
    
    Since:
    
    3.4.4
  - submitEngineUnsafeBatchTask
```
@Deprecated
<RESULT> RESULT submitEngineUnsafeBatchTask(java.lang.String engineName,
                                                        EngineConfig startupConfig,
                                                        com.graphdbapi.engine.unsafe.EngineTaskCallable<RESULT> batchTask)
```
    Deprecated.
    
    提交不安全的图引擎批处理任务, 不建议使用.
    
    Parameters:
    
    engineName - 图引擎名, 用于指定对应的图引擎，图引擎名全局唯一.
    
    startupConfig - 启动配置.
    
    batchTask - 批处理任务.
    
    Returns:
    
    批处理结果.
    
    Since:
    
    3.4.4
  - listEngineGraph
```
java.util.Map<java.lang.String,EngineStartupMeta> listEngineGraph()
```
    列出所有的图引擎信息.
    
    Returns:
    
    图引擎信息.
    
    Since:
    
    3.4.4

Interface TaskHandler

Method Summary

Method Detail

getIdsMap

getOrCreateTaskPools

submitTask

submitDistributedTask

getMessageInstance

remove

getTask

checkExecuteInfo

submitEngineBatchTask

hasStartup

submitEngineStartupTask

submitEngineBatchTask

submitEngineDropTask

submitEngineDropTask

submitEngineUnsafeBatchTask

listEngineGraph