org.pentaho.di.trans.step

Class StepIOMeta

java.lang.Object

org.pentaho.di.trans.step.StepIOMeta

All Implemented Interfaces:

Cloneable, StepIOMetaInterface

public class StepIOMeta
extends Object
implements StepIOMetaInterface, Cloneable

Constructor Summary

Constructors

Constructor and Description
StepIOMeta(boolean inputAcceptor, boolean outputProducer, boolean inputOptional, boolean sortedDataRequired, boolean inputDynamic, boolean outputDynamic)

Method Summary

Modifier and Type	Method and Description
void	addStream(StreamInterface stream) Add a stream to the steps I/O interface
void	clearStreams()
protected StepIOMeta	clone()
StreamInterface	findInfoStream(StepMeta infoStep)
StreamInterface	findTargetStream(StepMeta targetStep)
String	getGeneralInfoDescription()
String	getGeneralTargetDescription()
String[]	getInfoStepnames()
List<StreamInterface>	getInfoStreams()
String[]	getTargetStepnames()
List<StreamInterface>	getTargetStreams()
boolean	isInputAcceptor()
boolean	isInputDynamic()
boolean	isInputOptional()
boolean	isOutputDynamic()
boolean	isOutputProducer()
boolean	isSortedDataRequired()
void	setGeneralInfoDescription(String generalInfoDescription) Set the general info stream description
void	setGeneralTargetDescription(String generalTargetDescription) Set the general target stream description
void	setInfoSteps(StepMeta[] infoSteps) Replace the info steps with the supplied source steps.
void	setInputAcceptor(boolean inputAcceptor)
void	setInputDynamic(boolean inputDynamic)
void	setInputOptional(boolean inputOptional)
void	setOutputDynamic(boolean outputDynamic)
void	setOutputProducer(boolean outputProducer)
void	setSortedDataRequired(boolean sortedDataRequired)

Methods inherited from class java.lang.Object

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

Constructor Detail

StepIOMeta

public StepIOMeta(boolean inputAcceptor,
                  boolean outputProducer,
                  boolean inputOptional,
                  boolean sortedDataRequired,
                  boolean inputDynamic,
                  boolean outputDynamic)

Parameters:

inputAcceptor -

outputProducer -

Method Detail

clone

protected StepIOMeta clone()
                    throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

isInputAcceptor

public boolean isInputAcceptor()

Specified by:

isInputAcceptor in interface StepIOMetaInterface

Returns:

the inputAcceptor

setInputAcceptor

public void setInputAcceptor(boolean inputAcceptor)

Parameters:

inputAcceptor - the inputAcceptor to set

isOutputProducer

public boolean isOutputProducer()

Specified by:

isOutputProducer in interface StepIOMetaInterface

Returns:

the outputProducer

setOutputProducer

public void setOutputProducer(boolean outputProducer)

Parameters:

outputProducer - the outputProducer to set

isInputOptional

public boolean isInputOptional()

Specified by:

isInputOptional in interface StepIOMetaInterface

Returns:

the inputOptional

setInputOptional

public void setInputOptional(boolean inputOptional)

Parameters:

inputOptional - the inputOptional to set

getInfoStreams

public List<StreamInterface> getInfoStreams()

Specified by:

getInfoStreams in interface StepIOMetaInterface

Returns:

the info streams of this step. Important: Modifying this list does not have any effect on the Steps IO metadata.

getTargetStreams

public List<StreamInterface> getTargetStreams()

Specified by:

getTargetStreams in interface StepIOMetaInterface

Returns:

the target streams of this step. Important: Modifying this list does not have any effect on the Steps IO metadata.

isSortedDataRequired

public boolean isSortedDataRequired()

Specified by:

isSortedDataRequired in interface StepIOMetaInterface

Returns:

the sortedDataRequired

setSortedDataRequired

public void setSortedDataRequired(boolean sortedDataRequired)

Parameters:

sortedDataRequired - the sortedDataRequired to set

addStream

public void addStream(StreamInterface stream)

Description copied from interface: StepIOMetaInterface

Add a stream to the steps I/O interface

Specified by:

addStream in interface StepIOMetaInterface

Parameters:

stream - The stream to add

getInfoStepnames

public String[] getInfoStepnames()

Specified by:

getInfoStepnames in interface StepIOMetaInterface

getTargetStepnames

public String[] getTargetStepnames()

Specified by:

getTargetStepnames in interface StepIOMetaInterface

setInfoSteps

public void setInfoSteps(StepMeta[] infoSteps)

Replace the info steps with the supplied source steps.

Specified by:

setInfoSteps in interface StepIOMetaInterface

Parameters:

infoSteps -

getGeneralInfoDescription

public String getGeneralInfoDescription()

Specified by:

getGeneralInfoDescription in interface StepIOMetaInterface

Returns:

the generalInfoDescription

setGeneralInfoDescription

public void setGeneralInfoDescription(String generalInfoDescription)

Description copied from interface: StepIOMetaInterface

Set the general info stream description

Specified by:

setGeneralInfoDescription in interface StepIOMetaInterface

Parameters:

generalInfoDescription - the generalInfoDescription to set

getGeneralTargetDescription

public String getGeneralTargetDescription()

Specified by:

getGeneralTargetDescription in interface StepIOMetaInterface

Returns:

the generalTargetDescription

setGeneralTargetDescription

public void setGeneralTargetDescription(String generalTargetDescription)

Description copied from interface: StepIOMetaInterface

Set the general target stream description

Specified by:

setGeneralTargetDescription in interface StepIOMetaInterface

Parameters:

generalTargetDescription - the generalTargetDescription to set

clearStreams

public void clearStreams()

isOutputDynamic

public boolean isOutputDynamic()

Specified by:

isOutputDynamic in interface StepIOMetaInterface

Returns:

the outputDynamic

setOutputDynamic

public void setOutputDynamic(boolean outputDynamic)

Specified by:

setOutputDynamic in interface StepIOMetaInterface

Parameters:

outputDynamic - the outputDynamic to set

isInputDynamic

public boolean isInputDynamic()

Specified by:

isInputDynamic in interface StepIOMetaInterface

Returns:

the inputDynamic

setInputDynamic

public void setInputDynamic(boolean inputDynamic)

Specified by:

setInputDynamic in interface StepIOMetaInterface

Parameters:

inputDynamic - the inputDynamic to set

findTargetStream

public StreamInterface findTargetStream(StepMeta targetStep)

Specified by:

findTargetStream in interface StepIOMetaInterface

findInfoStream

public StreamInterface findInfoStream(StepMeta infoStep)

Specified by:

findInfoStream in interface StepIOMetaInterface