public interface StepStep
This interface represents an instance of a single entity in a Data Management Platform DataFlow.
A step is a unit of work. Steps may be linked together on a page to make a dataflow. This interface allows a plugin step to inspect information about another step in the job.
IMPORTANT: This interface should never be used outside the context and lifecycle of the plugin step to which they were provided. This means that an instance should not be passed as an argument to any method nor stored in a static location external to the plugin step instance that obtained it.
Modifier and Type | Method and Description |
---|---|
int |
getNumParents()
Returns the number of parents for this step.
|
long |
getNumRows()
Get the number of rows that this step will produce.
|
StepStep |
getParent(int index)
Get a parent of this step.
|
StepStatus |
getStatus()
Get the status and percentage complete of a running step.
|
int getNumParents()
StepStep getParent(int index) throws java.lang.IndexOutOfBoundsException
index
- The index of the parent to get.java.lang.IndexOutOfBoundsException
- if index is out of bounds.long getNumRows()
A step may not necessarily know how many rows it will produce.
This will only be valid after IStep.preExec()
and before IStep.postExec()
.
StepStatus getStatus()
Can only be called on a running step (after IStep.preExec()
,
before IStep.postExec()
).
StepStatus
containing the percent
complete and status message.Copyright © 2012 SAS Institute Inc. All Rights Reserved.