Package org.apache.hop.pipeline.engine
Interface IEngineComponent
-
- All Known Subinterfaces:
ITransform
- All Known Implementing Classes:
AbstractTransform,BaseFileInputTransform,BaseTransform,Dummy,EngineComponent,Injector,MissingTransform
public interface IEngineComponentAn identifiable component of an execution engineIPipelineEngineIn a pipeline engine this would be a transform
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddRowListener(IRowListener rowListener)Add a rowlistener to the transform allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the transform.intgetCopyNr()longgetErrors()longgetExecutionDuration()DategetExecutionEndDate()Gets executionEndDateDategetExecutionStartDate()Gets executionStartDateDategetFirstRowReadDate()Gets firstRowReadDateDategetInitStartDate()Gets initStartDatelonggetInputBufferSize()DategetLastRowWrittenDate()Gets lastRowWrittenDatelonggetLinesInput()longgetLinesOutput()longgetLinesRead()longgetLinesRejected()longgetLinesUpdated()longgetLinesWritten()ILogChannelgetLogChannel()StringgetLogChannelId()LogLevelgetLogLevel()StringgetLogText()Retrieve the logging text of this component in the engineStringgetName()longgetOutputBufferSize()EngineComponent.ComponentExecutionStatusgetStatus()Get the execution status of the componentStringgetStatusDescription()booleanisPaused()booleanisRunning()booleanisSelected()booleanisStopped()voidremoveRowListener(IRowListener rowListener)voidsetExecutionEndDate(Date executionEndDate)voidsetExecutionStartDate(Date executionStartDate)voidsetFirstRowReadDate(Date firstRowReadDate)voidsetInitStartDate(Date initStartDate)voidsetLastRowWrittenDate(Date lastRowWrittenDate)voidsetLogLevel(LogLevel logLevel)
-
-
-
Method Detail
-
getName
String getName()
- Returns:
- The component name
-
getCopyNr
int getCopyNr()
- Returns:
- The copy number (0 of higher for parallel runs)
-
getLogLevel
LogLevel getLogLevel()
-
setLogLevel
void setLogLevel(LogLevel logLevel)
-
getLogChannel
ILogChannel getLogChannel()
-
getLogChannelId
String getLogChannelId()
- Returns:
- The log channel ID or null if there is no separate log channel.
-
getLogText
String getLogText()
Retrieve the logging text of this component in the engine- Returns:
- logging text
-
isRunning
boolean isRunning()
- Returns:
- true if this component is running/active
-
isSelected
boolean isSelected()
- Returns:
- true if the component is selected in the user interface
-
isStopped
boolean isStopped()
- Returns:
- True if the component is stopped
-
isPaused
boolean isPaused()
- Returns:
- True if the component is paused
-
getErrors
long getErrors()
- Returns:
- The number of errors in this component
-
getLinesRead
long getLinesRead()
-
getLinesWritten
long getLinesWritten()
-
getLinesInput
long getLinesInput()
-
getLinesOutput
long getLinesOutput()
-
getLinesRejected
long getLinesRejected()
-
getLinesUpdated
long getLinesUpdated()
-
getStatusDescription
String getStatusDescription()
-
getExecutionDuration
long getExecutionDuration()
-
getInputBufferSize
long getInputBufferSize()
-
getOutputBufferSize
long getOutputBufferSize()
-
addRowListener
void addRowListener(IRowListener rowListener)
Add a rowlistener to the transform allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the transform.- Parameters:
rowListener- the rowlistener to add
-
removeRowListener
void removeRowListener(IRowListener rowListener)
-
getStatus
EngineComponent.ComponentExecutionStatus getStatus()
Get the execution status of the component- Returns:
-
getInitStartDate
Date getInitStartDate()
Gets initStartDate- Returns:
- value of initStartDate
-
setInitStartDate
void setInitStartDate(Date initStartDate)
- Parameters:
initStartDate- The initStartDate to set
-
getExecutionStartDate
Date getExecutionStartDate()
Gets executionStartDate- Returns:
- value of executionStartDate
-
setExecutionStartDate
void setExecutionStartDate(Date executionStartDate)
- Parameters:
executionStartDate- The executionStartDate to set
-
getFirstRowReadDate
Date getFirstRowReadDate()
Gets firstRowReadDate- Returns:
- value of firstRowReadDate
-
setFirstRowReadDate
void setFirstRowReadDate(Date firstRowReadDate)
- Parameters:
firstRowReadDate- The firstRowReadDate to set
-
getLastRowWrittenDate
Date getLastRowWrittenDate()
Gets lastRowWrittenDate- Returns:
- value of lastRowWrittenDate
-
setLastRowWrittenDate
void setLastRowWrittenDate(Date lastRowWrittenDate)
- Parameters:
lastRowWrittenDate- The lastRowWrittenDate to set
-
getExecutionEndDate
Date getExecutionEndDate()
Gets executionEndDate- Returns:
- value of executionEndDate
-
setExecutionEndDate
void setExecutionEndDate(Date executionEndDate)
- Parameters:
executionEndDate- The executionEndDate to set
-
-