WorkerContext (Graph SDK 0.20.7-public API)

java.lang.Object
- com.aliyun.odps.graph.WorkerContext<VERTEX_ID,VERTEX_VALUE,EDGE_VALUE,MESSAGE>

类型参数:

VERTEX_ID - Vertex ID 类型

VERTEX_VALUE - Vertex Value 类型

EDGE_VALUE - Edge Value 类型

MESSAGE - Message 类型

直接已知子类:

ComputeContext
```
public abstract class WorkerContext<VERTEX_ID extends WritableComparable,VERTEX_VALUE extends Writable,EDGE_VALUE extends Writable,MESSAGE extends Writable>
extends Object
```
Worker 上下文对象，封装了框架提供的核心功能.

构造器概要

构造器
构造器和说明

WorkerContext()

构造器
构造器和说明
`WorkerContext()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`abstract Writable`	`getComputeValue()` 获取当前 Worker 的计算对象，每轮开始时初始化，结束时发送给 Master。
`abstract Configuration`	`getConfiguration()` 获取作业配置.
`abstract Counter`	`getCounter(Enum<?> name)` 获取给定名称的Counter对象，name为`Enum`
`abstract Counter`	`getCounter(String group, String name)` 获取给定组名和名称的 Counter 对象.
`<VALUE extends Writable> VALUE`	`getLastAggregatedValue()` 默认获取上一轮迭代结束时编号0的 Aggregator 的结果.
`abstract <VALUE extends Writable> VALUE`	`getLastAggregatedValue(int aggregatorIndex)` 获取上一轮迭代结束时给定编号 Aggregator 的结果.
`abstract long`	`getMaxIteration()` 获取最大迭代次数，默认 -1，小于或等于 0 时表示最大迭代次数不作为作业终止条件.
`abstract int`	`getNumWorkers()` 获取 Worker 数目.
`abstract TableInfo`	`getOutputTable()` 获取默认输出的表信息.
`abstract TableInfo`	`getOutputTable(String label)` 获取给定输出标签的表信息.
`abstract TableInfo`	`getResourceTable(String resourceName)` 获取表类型资源对应的表信息，包括Project、表名称、分区等信息.
`abstract long`	`getSuperstep()` 获取当前超步，即第几次迭代，从 0 开始计数.
`abstract long`	`getTotalNumEdges()` 获取所有边数量，所有 Worker 负责的边数之和.
`abstract long`	`getTotalNumVertices()` 获取所有点数量，所有 Worker 负责的点数之和.
`abstract int`	`getWorkerId()` 获取当前 Worker 的编号，从 0 开始计数.
`abstract long`	`getWorkerNumEdges()` 获取当前 Worker 负责的边数量.
`abstract long`	`getWorkerNumVertices()` 获取当前 Worker 负责的点数量.
`abstract Writable`	`getWorkerValue()` 获取当前 Worker 的共享对象.
`abstract void`	`progress()` 向 ODPS Graph 框架报告进度.
`abstract Iterable<byte[]>`	`readCacheArchive(String resourceName)` 读取压缩档案类型资源，返回解压后的所有文件内容的迭代器.
`abstract Iterable<byte[]>`	`readCacheArchive(String resourceName, String relativePath)` 读取压缩档案类型资源，可以传入一个相对路径读取部分文件.
`abstract Iterable<BufferedInputStream>`	`readCacheArchiveAsStream(String resourceName)` 读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
`abstract Iterable<BufferedInputStream>`	`readCacheArchiveAsStream(String resourceName, String relativePath)` 读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
`abstract byte[]`	`readCacheFile(String resourceName)` 读取文件类型资源，一次全部读取到内存，返回 byte[].
`abstract BufferedInputStream`	`readCacheFileAsStream(String resourceName)` 读取文件类型资源，返回一个带缓存的输入流.
`abstract Iterable<WritableRecord>`	`readResourceTable(String resourceName)` 读取表类型资源，ODPS的小表（Table）也可以作为资源，大小限制参见ODPS的相关文档.
`abstract void`	`write(String label, Writable... fieldVals)` 写记录到给定标签输出.
`abstract void`	`write(Writable... fieldVals)` 写记录到默认输出.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - WorkerContext
```
public WorkerContext()
```
- 方法详细资料
  - getConfiguration
```
public abstract Configuration getConfiguration()
```
    获取作业配置. 在 GraphJob 设置的配置参数可以从作业配置中读取
    注意：这里只能get配置参数，而不能set配置参数
    
    返回:
    
    ODPS Graph 作业配置
  - getWorkerValue
```
public abstract Writable getWorkerValue()
```
    获取当前 Worker 的共享对象.
    
    返回:
    
    当前 Worker 的共享对象.
    
    另请参阅:
    
    WorkerComputer}
  - getWorkerId
```
public abstract int getWorkerId()
```
    获取当前 Worker 的编号，从 0 开始计数.
    
    返回:
    
    当前 Worker 的编号，从 0 开始计数.
  - getNumWorkers
```
public abstract int getNumWorkers()
```
    获取 Worker 数目.
    
    返回:
    
    Worker 数目
  - getSuperstep
```
public abstract long getSuperstep()
```
    获取当前超步，即第几次迭代，从 0 开始计数.
    
    返回:
    
    当前超步
  - getMaxIteration
```
public abstract long getMaxIteration()
```
    获取最大迭代次数，默认 -1，小于或等于 0 时表示最大迭代次数不作为作业终止条件.
    
    返回:
    
    最大迭代次数
    
    另请参阅:
    
    JobConf.setMaxIteration(int)
  - getWorkerNumVertices
```
public abstract long getWorkerNumVertices()
```
    获取当前 Worker 负责的点数量.
    
    返回:
    
    当前 Worker 负责的点数量
  - getWorkerNumEdges
```
public abstract long getWorkerNumEdges()
```
    获取当前 Worker 负责的边数量.
    
    返回:
    
    当前 Worker 负责的边数量
  - getTotalNumVertices
```
public abstract long getTotalNumVertices()
```
    获取所有点数量，所有 Worker 负责的点数之和.
    
    返回:
    
    所有点数量
  - getTotalNumEdges
```
public abstract long getTotalNumEdges()
```
    获取所有边数量，所有 Worker 负责的边数之和.
    
    返回:
    
    所有边数量
  - getCounter
```
public abstract Counter getCounter(Enum<?> name)
```
    获取给定名称的Counter对象，name为Enum
    
    参数:
    
    name - Counter名称
    
    返回:
  - getCounter
```
public abstract Counter getCounter(String group,
                                   String name)
```
    获取给定组名和名称的 Counter 对象.
    
    参数:
    
    group - Counter 组名
    
    name - Counter 名
    
    返回:
  - getLastAggregatedValue
```
public abstract <VALUE extends Writable> VALUE getLastAggregatedValue(int aggregatorIndex)
```
    获取上一轮迭代结束时给定编号 Aggregator 的结果.
    对于第一轮迭代（超步为0），调用本方法返回 Aggregator.createStartupValue(WorkerContext) 创建的值， Aggregator.createStartupValue(WorkerContext) 默认返回 null，用户可以 override.
    
    类型参数:
    
    VALUE - Aggregator 值类型
    
    参数:
    
    aggregatorIndex - Aggregator编号，起始为 0
    
    返回:
    
    另请参阅:
    
    Aggregator.aggregate(Writable, Object), JobConf.setAggregatorClass(Class...)
  - getLastAggregatedValue
```
public <VALUE extends Writable> VALUE getLastAggregatedValue()
```
    默认获取上一轮迭代结束时编号0的 Aggregator 的结果.
    对于第一轮迭代（超步为0），调用本方法返回 Aggregator.createStartupValue(WorkerContext) 创建的值， Aggregator.createStartupValue(WorkerContext) 默认返回 null，用户可以 override.
    
    类型参数:
    
    VALUE - Aggregator 值类型
    
    返回:
    
    另请参阅:
    
    Aggregator.aggregate(Writable, Object), JobConf.setAggregatorClass(Class...)
  - getOutputTable
```
public abstract TableInfo getOutputTable()
                                  throws IOException
```
    获取默认输出的表信息.
    
    返回:
    
    默认输出的表信息
    
    抛出:
    
    IOException
  - getOutputTable
```
public abstract TableInfo getOutputTable(String label)
                                  throws IOException
```
    获取给定输出标签的表信息.
    
    参数:
    
    label - 输出标签
    
    返回:
    
    给定输出标签的表信息
    
    抛出:
    
    IOException
  - write
```
public abstract void write(Writable... fieldVals)
                    throws IOException
```
    写记录到默认输出.
    
    参数:
    
    fieldVals - 待写出的记录值
    
    抛出:
    
    IOException
    
    另请参阅:
    
    JobConf.addOutput(TableInfo)
  - write
```
public abstract void write(String label,
                           Writable... fieldVals)
                    throws IOException
```
    写记录到给定标签输出.
    
    参数:
    
    label - 输出标签
    
    fieldVals - 待写出的记录值
    
    抛出:
    
    IOException
    
    另请参阅:
    
    GraphJob#addOutput(TableInfo, String)
  - readCacheFile
```
public abstract byte[] readCacheFile(String resourceName)
                              throws IOException
```
    读取文件类型资源，一次全部读取到内存，返回 byte[].
    如果资源文件比较大，应该使用readCacheFileAsStream(String) 获得一个带缓存的输入流，支持边读边处理，防止Java内存溢出
    
    使用文件类型资源步骤：
    1. 上传资源文件： console < add file res_file.txt;
    2. 运行 ODPS Graph 作业命令: console < jar -resources res_file.txt ...，或者使用API（ JobConf.addCacheResources(String)）
    3. ODPS Graph 作业里读取资源：context.readCacheFile("res_file.txt");
    资源文件在运行时会下载到所在的节点机器上并缓存，类似于Hadoop的DistributedCache
    参数:
    
    resourceName - 资源名称
    
    返回:
    
    资源内容
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheFileAsStream(String)
  - readCacheFileAsStream
```
public abstract BufferedInputStream readCacheFileAsStream(String resourceName)
                                                   throws IOException
```
    读取文件类型资源，返回一个带缓存的输入流.
    readCacheFileAsStream 支持边读边处理（常见的场景是读取一行处理一行），适合读取比较大的文件资源，防止Java内存溢出，如果文件资源比较小，也可以直接使用 readCacheFile(String) 方法一次性读取到内存。
    
    使用文件类型资源步骤类似readCacheFile(String)
    
    参数:
    
    resourceName - 资源名称
    
    返回:
    
    资源内容的BufferedInputStream
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheFile(String)
  - readCacheArchive
```
public abstract Iterable<byte[]> readCacheArchive(String resourceName)
                                           throws IOException
```
    读取压缩档案类型资源，返回解压后的所有文件内容的迭代器.
    如果文件内容比较大，应该使用 readCacheArchiveAsStream(String) ，支持边读边处理，防止Java内存溢出。
    
    使用压缩档案类型资源步骤：
    1. 上传资源压缩包： console < add archive ref_archive.tar.gz;
    2. 运行 ODPS Graph 作业命令: console < jar -resources ref_archive.tar.gz ...，或者使用API（ JobConf.addCacheResources(String)）
    3. ODPS Graph 里读取资源：context.readCacheArchive("ref_archive.tar.gz");
    资源压缩包在Worker运行时会下载到所在的节点机器上并缓存，类似于Hadoop的DistributedCache
    参数:
    
    resourceName - 资源名称
    
    返回:
    
    压缩包解压后的所有文件内容迭代器
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheArchiveAsStream(String)
  - readCacheArchive
```
public abstract Iterable<byte[]> readCacheArchive(String resourceName,
                                                  String relativePath)
                                           throws IOException
```
    读取压缩档案类型资源，可以传入一个相对路径读取部分文件.
    与readCacheArchive(String) 不同的是可以传入一个相对路径，用于读取压缩包里的部分文件的内容，更多说明见 readCacheArchive(String)方法
    
    读取压缩包内子目录的代码示例：
```
 Iterable<byte[]> iter = context.readCacheArchiveAsStream(RESOURCE_ARCHIVE,
     "subdir/*");
 for (byte[] content : iter) {
 }
 
```
    参数:
    
    resourceName - 资源名称
    
    relativePath - 读取资源的相对路径
    
    返回:
    
    文件内容迭代器
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheArchiveAsStream(String)
  - readCacheArchiveAsStream
```
public abstract Iterable<BufferedInputStream> readCacheArchiveAsStream(String resourceName)
                                                                throws IOException
```
    读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
    
    参数:
    
    resourceName - 资源名称
    
    返回:
    
    BufferedInputStream的迭代器
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheArchive(String)
  - readCacheArchiveAsStream
```
public abstract Iterable<BufferedInputStream> readCacheArchiveAsStream(String resourceName,
                                                                       String relativePath)
                                                                throws IOException
```
    读取压缩档案类型资源，返回 BufferedInputStream 的迭代器.
    
    参数:
    
    resourceName - 资源名称
    
    relativePath - 读取资源的相对路径
    
    返回:
    
    BufferedInputStream的迭代器
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他读取错误抛异常
    
    另请参阅:
    
    readCacheArchive(String, String)
  - readResourceTable
```
public abstract Iterable<WritableRecord> readResourceTable(String resourceName)
                                                    throws IOException
```
    读取表类型资源，ODPS的小表（Table）也可以作为资源，大小限制参见ODPS的相关文档.
    使用表类型资源步骤：
    1. 增加资源表： console < add table my_table partition(ds='1') as res_table;
    2. 运行 ODPS Graph 作业命令: console < jar -resources res_table ...，或者使用API（ JobConf.addCacheResources(String)）
    3. ODPS Graph 里读取资源：context.readResourceTable("res_table");
    代码示例：
```
 Iterable<WritableRecord> iter = context.readResourceTable("res_table");
 for (WritableRecord record : iter) {
   // handle record
 }
 
```
    参数:
    
    resourceName - 表类型资源名称
    
    返回:
    
    记录迭代器
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他错误抛异常
  - getResourceTable
```
public abstract TableInfo getResourceTable(String resourceName)
                                    throws IOException
```
    获取表类型资源对应的表信息，包括Project、表名称、分区等信息.
    
    参数:
    
    resourceName - 表类型资源名称
    
    返回:
    
    表信息
    
    抛出:
    
    IOException - 资源未声明、资源类型不匹配以及其他错误抛异常
  - progress
```
public abstract void progress()
```
    向 ODPS Graph 框架报告进度. 如果用户方法处理时间很长，且中间没有调用框架，可以调用这个方法避免worker超时，框架默认600秒超时.
  - getComputeValue
```
public abstract Writable getComputeValue()
```
    获取当前 Worker 的计算对象，每轮开始时初始化，结束时发送给 Master。在 MasterComputer 中能获取到各个 Worker 的 ComputeValue.
    
    返回:
    
    返回当前 Worker 的计算对象

类 WorkerContext<VERTEX_ID extends WritableComparable,VERTEX_VALUE extends Writable,EDGE_VALUE extends Writable,MESSAGE extends Writable>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

WorkerContext

方法详细资料

getConfiguration

getWorkerValue

getWorkerId

getNumWorkers

getSuperstep

getMaxIteration

getWorkerNumVertices

getWorkerNumEdges

getTotalNumVertices

getTotalNumEdges

getCounter

getCounter

getLastAggregatedValue

getLastAggregatedValue

getOutputTable

getOutputTable

write

write

readCacheFile

readCacheFileAsStream

readCacheArchive

readCacheArchive

readCacheArchiveAsStream

readCacheArchiveAsStream

readResourceTable

getResourceTable

progress

getComputeValue