ml.shifu.guagua.worker

Class WorkerContext<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>

java.lang.Object

ml.shifu.guagua.worker.WorkerContext<MASTER_RESULT,WORKER_RESULT>

Type Parameters:

MASTER_RESULT - master result for computation in each iteration.

WORKER_RESULT - worker result for computation in each iteration.

public class WorkerContext<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>
extends Object

WorkerContext is a context to contain all useful info which can be used in worker computation.

The info includes:

• Application ID: Job ID for Hadoop mapreduce job, application id for YARN application.
• Container ID: Task index for Hadoop mapreduce task, Task index for YARN Container.
• Total iteration number.
• Current iteration number.
• Worker result for current iteration after computation which is used to be sent to master.
• Master result from last iteration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkerContext.WorkerCompletionCallBack<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable> Define callback for completion of worker computation.

Constructor Summary

Constructors

Constructor and Description
WorkerContext(int totalIteration, String appId, Properties props, String containerId, List<GuaguaFileSplit> fileSplits, String masterResultClassName, String workerResultClassName)

Method Summary

Modifier and Type	Method and Description
void	addCompletionCallBack(WorkerContext.WorkerCompletionCallBack<MASTER_RESULT,WORKER_RESULT> callback) Add callback function.
String	getAppId()
Object	getAttachment()
List<WorkerContext.WorkerCompletionCallBack<MASTER_RESULT,WORKER_RESULT>>	getCallBackList()
String	getContainerId()
int	getCurrentIteration()
List<GuaguaFileSplit>	getFileSplits()
MASTER_RESULT	getLastMasterResult()
String	getMasterResultClassName()
Properties	getProps()
int	getTotalIteration()
WORKER_RESULT	getWorkerResult()
String	getWorkerResultClassName()
boolean	isFirstIteration() Whether is in first iteration, default first iteration is 1.
boolean	isInitIteration() Whether is in initiate iteration, default initiate iteration is 1.
void	setAttachment(Object attachment)
void	setCurrentIteration(int currentIteration)
void	setLastMasterResult(MASTER_RESULT lastMasterResult)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerContext

public WorkerContext(int totalIteration,
                     String appId,
                     Properties props,
                     String containerId,
                     List<GuaguaFileSplit> fileSplits,
                     String masterResultClassName,
                     String workerResultClassName)

Method Detail

getCurrentIteration

public int getCurrentIteration()

setCurrentIteration

public void setCurrentIteration(int currentIteration)

getTotalIteration

public int getTotalIteration()

getLastMasterResult

public MASTER_RESULT getLastMasterResult()

setLastMasterResult

public void setLastMasterResult(MASTER_RESULT lastMasterResult)

getAppId

public String getAppId()

getContainerId

public String getContainerId()

getFileSplits

public List<GuaguaFileSplit> getFileSplits()

getProps

public Properties getProps()

getWorkerResult

public WORKER_RESULT getWorkerResult()

getWorkerResultClassName

public String getWorkerResultClassName()

getMasterResultClassName

public String getMasterResultClassName()

getAttachment

public Object getAttachment()

setAttachment

public void setAttachment(Object attachment)

isFirstIteration

public boolean isFirstIteration()

Whether is in first iteration, default first iteration is 1.

isInitIteration

public boolean isInitIteration()

Whether is in initiate iteration, default initiate iteration is 1.

addCompletionCallBack

public void addCompletionCallBack(WorkerContext.WorkerCompletionCallBack<MASTER_RESULT,WORKER_RESULT> callback)

Add callback function. Be careful not add it in each iteration.

getCallBackList

public List<WorkerContext.WorkerCompletionCallBack<MASTER_RESULT,WORKER_RESULT>> getCallBackList()

Returns:

the callBackList

toString

public String toString()

Overrides:

toString in class Object