GuaguaWorkerService (guagua-core 0.7.8 API)

java.lang.Object
- ml.shifu.guagua.worker.GuaguaWorkerService<MASTER_RESULT,WORKER_RESULT>

Type Parameters:

MASTER_RESULT - master computation result in each iteration.

WORKER_RESULT - worker computation result in each iteration.

All Implemented Interfaces:

GuaguaService
```
public class GuaguaWorkerService<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>
extends Object
implements GuaguaService
```
GuaguaWorkerService is the basic implementation as a worker for whole application process.
All the properties used to create computable instance, interceptor instances are set in props.
After workerComputable, workerInterceptors are constructed, they will be used in start(), run(Progressable), stop() to do the whole iteration logic.
GuaguaWorkerService is only a skeleton and all implementations are in the interceptors and computable classes defined by user.
The execution order of preXXXX is different with postXXXX. For preXXX, the order is FIFO, but for postXXX, the order is FILO.

Constructor Summary

Constructors
Constructor and Description

GuaguaWorkerService()

Constructors
Constructor and Description
`GuaguaWorkerService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppId()`
`String`	`getContainerId()`
`InMemoryCoordinator<MASTER_RESULT,WORKER_RESULT>`	`getCoordinator()`
`String`	`getMasterResultClassName()`
`Properties`	`getProps()`
`List<GuaguaFileSplit>`	`getSplits()`
`int`	`getTotalIteration()`
`WorkerComputable<MASTER_RESULT,WORKER_RESULT>`	`getWorkerComputable()`
`List<WorkerInterceptor<MASTER_RESULT,WORKER_RESULT>>`	`getWorkerInterceptors()`
`String`	`getWorkerResultClassName()`
`void`	`init(Properties props)` Parameter initialization, such as set result class name, iteration number and so on.
`protected WORKER_RESULT`	`iterate(WorkerContext<MASTER_RESULT,WORKER_RESULT> context, int initialIteration, Progressable progress)` Call each iteration computation and preIteration, postIteration in interceptors.
`void`	`run(Progressable progress)` Iterate `WorkerComputable.compute(WorkerContext)`, and set hook point before and after each iteration.
`void`	`setAppId(String appId)` App id for whole application.
`void`	`setContainerId(String containerId)` Set the unique container id for master or worker.
`void`	`setCoordinator(InMemoryCoordinator<MASTER_RESULT,WORKER_RESULT> coordinator)`
`void`	`setMasterResultClassName(String masterResultClassName)`
`void`	`setProps(Properties props)`
`void`	`setSplits(List<GuaguaFileSplit> splits)` Assign splits to each worker to make them load that data.
`void`	`setTotalIteration(int totalIteration)`
`void`	`setWorkerComputable(WorkerComputable<MASTER_RESULT,WORKER_RESULT> workerComputable)`
`void`	`setWorkerInterceptors(List<WorkerInterceptor<MASTER_RESULT,WORKER_RESULT>> workerInterceptors)`
`void`	`setWorkerResultClassName(String workerResultClassName)`
`void`	`start()` Start services from interceptors, all services started logic should be wrapperd in `WorkerInterceptor.preApplication(WorkerContext)`;
`void`	`stop()` Stop services from interceptors which is used for resource cleaning or servers shutting down.

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

- Constructor Detail
  - GuaguaWorkerService
```
public GuaguaWorkerService()
```
- Method Detail
  - start
```
public void start()
```
    Start services from interceptors, all services started logic should be wrapperd in WorkerInterceptor.preApplication(WorkerContext);
    
    Specified by:
    
    start in interface GuaguaService
  - stop
```
public void stop()
```
    Stop services from interceptors which is used for resource cleaning or servers shutting down.
    
    Specified by:
    
    stop in interface GuaguaService
  - run
```
public void run(Progressable progress)
```
    Iterate WorkerComputable.compute(WorkerContext), and set hook point before and after each iteration.
    
    Specified by:
    
    run in interface GuaguaService
  - iterate
```
protected WORKER_RESULT iterate(WorkerContext<MASTER_RESULT,WORKER_RESULT> context,
                                int initialIteration,
                                Progressable progress)
```
    Call each iteration computation and preIteration, postIteration in interceptors.
  - init
```
public void init(Properties props)
```
    Parameter initialization, such as set result class name, iteration number and so on.
    
    Specified by:
    
    init in interface GuaguaService
    
    Parameters:
    
    props - which contains different properties for master and workers to use.
  - getProps
```
public Properties getProps()
```
  - setProps
```
public void setProps(Properties props)
```
  - getSplits
```
public List<GuaguaFileSplit> getSplits()
```
  - setSplits
```
public void setSplits(List<GuaguaFileSplit> splits)
```
    Description copied from interface: GuaguaService
    
    Assign splits to each worker to make them load that data.
    
    Specified by:
    
    setSplits in interface GuaguaService
  - getAppId
```
public String getAppId()
```
  - setAppId
```
public void setAppId(String appId)
```
    Description copied from interface: GuaguaService
    
    App id for whole application. For example: Job id in MapReduce(hadoop 1.0) or application id in Yarn.
    
    Specified by:
    
    setAppId in interface GuaguaService
  - getContainerId
```
public String getContainerId()
```
  - setContainerId
```
public void setContainerId(String containerId)
```
    Description copied from interface: GuaguaService
    
    Set the unique container id for master or worker. For example: Task id in MapReduce or container id in Yarn.
    
    Specified by:
    
    setContainerId in interface GuaguaService
  - getWorkerComputable
```
public WorkerComputable<MASTER_RESULT,WORKER_RESULT> getWorkerComputable()
```
  - setWorkerComputable
```
public void setWorkerComputable(WorkerComputable<MASTER_RESULT,WORKER_RESULT> workerComputable)
```
  - getTotalIteration
```
public int getTotalIteration()
```
  - setTotalIteration
```
public void setTotalIteration(int totalIteration)
```
  - getWorkerInterceptors
```
public List<WorkerInterceptor<MASTER_RESULT,WORKER_RESULT>> getWorkerInterceptors()
```
  - setWorkerInterceptors
```
public void setWorkerInterceptors(List<WorkerInterceptor<MASTER_RESULT,WORKER_RESULT>> workerInterceptors)
```
  - getMasterResultClassName
```
public String getMasterResultClassName()
```
  - setMasterResultClassName
```
public void setMasterResultClassName(String masterResultClassName)
```
  - getWorkerResultClassName
```
public String getWorkerResultClassName()
```
  - setWorkerResultClassName
```
public void setWorkerResultClassName(String workerResultClassName)
```
  - getCoordinator
```
public InMemoryCoordinator<MASTER_RESULT,WORKER_RESULT> getCoordinator()
```
  - setCoordinator
```
public void setCoordinator(InMemoryCoordinator<MASTER_RESULT,WORKER_RESULT> coordinator)
```

Class GuaguaWorkerService<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GuaguaWorkerService

Method Detail

start

stop

run

iterate

init

getProps

setProps

getSplits

setSplits

getAppId

setAppId

getContainerId

setContainerId

getWorkerComputable

setWorkerComputable

getTotalIteration

setTotalIteration

getWorkerInterceptors

setWorkerInterceptors

getMasterResultClassName

setMasterResultClassName

getWorkerResultClassName

setWorkerResultClassName

getCoordinator

setCoordinator