com.hof.mi.etl.runner.status

Interface ETLStepStatus

All Known Implementing Classes:

ETLStepStatusConcurrentImpl, ETLStepStatusImpl

public interface ETLStepStatus

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ETLStepStatus.ETLStepStatusCode Step status codes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addData(ETLStepResult newData) Add one or more rows of data to the step's cache.
void	addError(ETLException e) Add an unhandled error to the set of errors.
void	cancel() Set the status of the step to cancelled, if it is not complete.
ETLStepResult	getData(java.lang.String outFlowUuid) Get data generated emitted by this step along the specified output flow UUID.
long	getEndTime() End Time as milliseconds from midnight, January 1, 1970 UTC.
java.util.Collection<ETLException>	getErrors() Get all unhandled errors.
java.util.Map<java.lang.String,java.lang.Long>	getProcessedRowCount() Number of rows processed by the step and sent down the chain for each flow.
long	getProcessedRowCount(java.lang.String outFlowUuid) Number of rows processed by the step and sent down the chain for a given flowUUID.
long	getStartTime() Start Time as milliseconds from midnight, January 1, 1970 UTC.
ETLStepStatus.ETLStepStatusCode	getStatusCode() Get the current status of the step represented by ETLStepStatus.ETLStepStatusCode
java.lang.String	getStepUuid() UUID of the step whose status is encapsulated here.
boolean	hasErrors() Were there any unhandled errors?
boolean	isComplete() True when the step has finished.
void	rowProcessed(java.lang.String outFlowUuid) Indicate that a row has been processed on a given flow.
void	setStatusCode(ETLStepStatus.ETLStepStatusCode statusCode) Set the step's status to an ETLStepStatus.ETLStepStatusCode

Method Detail

getStepUuid

java.lang.String getStepUuid()

UUID of the step whose status is encapsulated here.

getProcessedRowCount

java.util.Map<java.lang.String,java.lang.Long> getProcessedRowCount()

Number of rows processed by the step and sent down the chain for each flow.

getProcessedRowCount

long getProcessedRowCount(java.lang.String outFlowUuid)

Number of rows processed by the step and sent down the chain for a given flowUUID.

getStartTime

long getStartTime()

Start Time as milliseconds from midnight, January 1, 1970 UTC.

getEndTime

long getEndTime()

End Time as milliseconds from midnight, January 1, 1970 UTC.

isComplete

boolean isComplete()

True when the step has finished. It may not have finished successfully.

hasErrors

boolean hasErrors()

Were there any unhandled errors?

getErrors

java.util.Collection<ETLException> getErrors()

Get all unhandled errors.

getData

ETLStepResult getData(java.lang.String outFlowUuid)

Get data generated emitted by this step along the specified output flow UUID. When there is no output flow, this should return data corresponding to the default metadata.

rowProcessed

void rowProcessed(java.lang.String outFlowUuid)

Indicate that a row has been processed on a given flow.

addData

void addData(ETLStepResult newData)

Add one or more rows of data to the step's cache.

Parameters:

newData - - Instance of ETLStepResult.

addError

void addError(ETLException e)

Add an unhandled error to the set of errors.

getStatusCode

ETLStepStatus.ETLStepStatusCode getStatusCode()

Get the current status of the step represented by ETLStepStatus.ETLStepStatusCode

setStatusCode

void setStatusCode(ETLStepStatus.ETLStepStatusCode statusCode)

Set the step's status to an ETLStepStatus.ETLStepStatusCode

cancel

void cancel()

Set the status of the step to cancelled, if it is not complete.