public class StepMeta extends org.pentaho.di.shared.SharedObjectBase implements Cloneable, Comparable<StepMeta>, org.pentaho.di.core.gui.GUIPositionInterface, org.pentaho.di.shared.SharedObjectInterface, org.pentaho.di.core.CheckResultSourceInterface, ResourceExportInterface, ResourceHolderInterface, org.pentaho.di.core.AttributesInterface
| Modifier and Type | Field and Description | 
|---|---|
static String | 
STRING_ID_ETL_META_INJECT  | 
static String | 
STRING_ID_JOB_EXECUTOR  | 
static String | 
STRING_ID_MAPPING  | 
static String | 
STRING_ID_MAPPING_INPUT  | 
static String | 
STRING_ID_MAPPING_OUTPUT  | 
static String | 
STRING_ID_SINGLE_THREADER  | 
static String | 
XML_TAG  | 
| Constructor and Description | 
|---|
StepMeta()  | 
StepMeta(Node stepnode,
        List<org.pentaho.di.core.database.DatabaseMeta> databases,
        org.pentaho.metastore.api.IMetaStore metaStore)
Read the step data from XML 
 | 
StepMeta(Node stepnode,
        List<org.pentaho.di.core.database.DatabaseMeta> databases,
        Map<String,org.pentaho.di.core.Counter> counters)
Deprecated. 
 
 | 
StepMeta(org.pentaho.di.repository.ObjectId id_step)  | 
StepMeta(String stepname,
        StepMetaInterface stepMetaInterface)  | 
StepMeta(String stepid,
        String stepname,
        StepMetaInterface stepMetaInterface)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
     TransMeta transMeta,
     org.pentaho.di.core.row.RowMetaInterface prev,
     String[] input,
     String[] output,
     org.pentaho.di.core.row.RowMetaInterface info)
 | 
void | 
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
     TransMeta transMeta,
     org.pentaho.di.core.row.RowMetaInterface prev,
     String[] input,
     String[] output,
     org.pentaho.di.core.row.RowMetaInterface info,
     org.pentaho.di.core.variables.VariableSpace space,
     Repository repository,
     org.pentaho.metastore.api.IMetaStore metaStore)  | 
boolean | 
chosesTargetSteps()  | 
Object | 
clone()  | 
int | 
compareTo(StepMeta o)  | 
void | 
drawStep()  | 
boolean | 
equals(Object obj)
Two steps are equal if their names are equal. 
 | 
String | 
exportResources(org.pentaho.di.core.variables.VariableSpace space,
               Map<String,ResourceDefinition> definitions,
               ResourceNamingInterface resourceNamingInterface,
               Repository repository)
 | 
String | 
exportResources(org.pentaho.di.core.variables.VariableSpace space,
               Map<String,ResourceDefinition> definitions,
               ResourceNamingInterface resourceNamingInterface,
               Repository repository,
               org.pentaho.metastore.api.IMetaStore metaStore)
Exports the object to a flat-file system, adding content with filename keys to a set of definitions. 
 | 
static StepMeta | 
findStep(List<StepMeta> steps,
        org.pentaho.di.repository.ObjectId id)
Find a step with the ID in a given ArrayList of steps 
 | 
static StepMeta | 
findStep(List<StepMeta> steps,
        String stepname)
Find a step with its name in a given ArrayList of steps 
 | 
void | 
flipSelected()  | 
String | 
getAttribute(String groupName,
            String key)  | 
Map<String,String> | 
getAttributes(String groupName)  | 
Map<String,Map<String,String>> | 
getAttributesMap()  | 
ClusterSchema | 
getClusterSchema()  | 
int | 
getCopies()
Get the number of copies to start of a step. 
 | 
String | 
getCopiesString()  | 
String | 
getDescription()  | 
String | 
getHolderType()
Gets the high-level type of resource holder. 
 | 
org.pentaho.di.core.gui.Point | 
getLocation()  | 
String | 
getName()  | 
org.pentaho.di.repository.ObjectId | 
getObjectId()  | 
TransMeta | 
getParentTransMeta()  | 
List<RemoteStep> | 
getRemoteInputSteps()  | 
List<RemoteStep> | 
getRemoteOutputSteps()  | 
List<ResourceReference> | 
getResourceDependencies(TransMeta transMeta)
Get a list of all the resource dependencies that the step is depending on. 
 | 
RowDistributionInterface | 
getRowDistribution()  | 
StepErrorMeta | 
getStepErrorMeta()  | 
String | 
getStepID()  | 
StepMetaInterface | 
getStepMetaInterface()  | 
StepPartitioningMeta | 
getStepPartitioningMeta()  | 
StepPartitioningMeta | 
getTargetStepPartitioningMeta()  | 
String | 
getTypeId()
Support for CheckResultSourceInterface 
 | 
String | 
getXML()  | 
String | 
getXML(boolean includeInterface)  | 
boolean | 
hasChanged()  | 
int | 
hashCode()  | 
boolean | 
hasTerminator()  | 
void | 
hideStep()  | 
boolean | 
isClustered()  | 
boolean | 
isDistributes()  | 
boolean | 
isDoingErrorHandling()  | 
boolean | 
isDrawn()
See wether or not the step is drawn on the canvas. 
 | 
boolean | 
isDrawStep()
See wether or not the step is drawn on the canvas. 
 | 
boolean | 
isEtlMetaInject()  | 
boolean | 
isJobExecutor()  | 
boolean | 
isMapping()  | 
boolean | 
isMappingInput()  | 
boolean | 
isMappingOutput()  | 
boolean | 
isMissing()  | 
boolean | 
isPartitioned()  | 
boolean | 
isRepartitioning()  | 
boolean | 
isSelected()  | 
boolean | 
isSendingErrorRowsToStep(StepMeta targetStep)  | 
boolean | 
isSingleThreader()  | 
boolean | 
isTargetPartitioned()  | 
void | 
replaceMeta(StepMeta stepMeta)  | 
void | 
setAttribute(String groupName,
            String key,
            String value)  | 
void | 
setAttributes(String groupName,
             Map<String,String> attributes)  | 
void | 
setAttributesMap(Map<String,Map<String,String>> attributesMap)  | 
void | 
setChanged()  | 
void | 
setChanged(boolean ch)  | 
void | 
setClusterSchema(ClusterSchema clusterSchema)  | 
void | 
setClusterSchemaAfterLoading(List<ClusterSchema> clusterSchemas)
Resolves the name of the cluster loaded from XML/Repository to the correct clusterSchema object 
 | 
void | 
setClusterSchemaName(String clusterSchemaName)  | 
void | 
setCopies(int c)
Sets the number of parallel copies that this step will be launched with. 
 | 
void | 
setCopiesString(String copiesString)  | 
void | 
setDescription(String description)  | 
void | 
setDistributes(boolean distributes)  | 
void | 
setDraw(boolean draw)
Sets the draw attribute of the step so that it will be drawn on the canvas. 
 | 
void | 
setLocation(int x,
           int y)  | 
void | 
setLocation(org.pentaho.di.core.gui.Point loc)  | 
void | 
setName(String sname)  | 
void | 
setObjectId(org.pentaho.di.repository.ObjectId id)  | 
void | 
setParentTransMeta(TransMeta parentTransMeta)  | 
void | 
setRemoteInputSteps(List<RemoteStep> remoteInputSteps)  | 
void | 
setRemoteOutputSteps(List<RemoteStep> remoteOutputSteps)  | 
void | 
setRowDistribution(RowDistributionInterface rowDistribution)  | 
void | 
setSelected(boolean sel)  | 
void | 
setStepErrorMeta(StepErrorMeta stepErrorMeta)  | 
void | 
setStepID(String stepid)
Set the plugin step id (code) 
 | 
void | 
setStepMetaInterface(StepMetaInterface stepMetaInterface)  | 
void | 
setStepPartitioningMeta(StepPartitioningMeta stepPartitioningMeta)  | 
void | 
setTargetStepPartitioningMeta(StepPartitioningMeta targetStepPartitioningMeta)  | 
void | 
setTerminator()  | 
void | 
setTerminator(boolean t)  | 
boolean | 
supportsErrorHandling()  | 
String | 
toString()  | 
public static final String XML_TAG
public static final String STRING_ID_MAPPING
public static final String STRING_ID_SINGLE_THREADER
public static final String STRING_ID_ETL_META_INJECT
public static final String STRING_ID_JOB_EXECUTOR
public static final String STRING_ID_MAPPING_INPUT
public static final String STRING_ID_MAPPING_OUTPUT
public StepMeta(String stepid, String stepname, StepMetaInterface stepMetaInterface)
stepid - The ID of the step: this is derived information, you can also use the constructor without stepid. This
          constructor will be deprecated soon.stepname - The name of the new stepstepMetaInterface - The step metadata interface to use (TextFileInputMeta, etc)public StepMeta(String stepname, StepMetaInterface stepMetaInterface)
stepname - The name of the new stepstepMetaInterface - The step metadata interface to use (TextFileInputMeta, etc)public StepMeta()
@Deprecated public StepMeta(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleXMLException, org.pentaho.di.core.exception.KettlePluginLoaderException
StepMeta(Node, List, IMetaStore)stepnode - The XML step node.databases - A list of databasescounters - A map with all defined counters.org.pentaho.di.core.exception.KettleXMLExceptionorg.pentaho.di.core.exception.KettlePluginLoaderExceptionpublic StepMeta(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException, org.pentaho.di.core.exception.KettlePluginLoaderException
stepnode - The XML step node.databases - A list of databasescounters - A map with all defined counters.org.pentaho.di.core.exception.KettleXMLExceptionorg.pentaho.di.core.exception.KettlePluginLoaderExceptionpublic StepMeta(org.pentaho.di.repository.ObjectId id_step)
public String getXML() throws org.pentaho.di.core.exception.KettleException
getXML in interface org.pentaho.di.shared.SharedObjectInterfaceorg.pentaho.di.core.exception.KettleExceptionpublic String getXML(boolean includeInterface) throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleExceptionpublic void setClusterSchemaAfterLoading(List<ClusterSchema> clusterSchemas)
clusterSchemas - The list of clusterSchemas to reference.public org.pentaho.di.repository.ObjectId getObjectId()
getObjectId in interface org.pentaho.di.core.CheckResultSourceInterfacegetObjectId in interface ResourceHolderInterfacepublic void setObjectId(org.pentaho.di.repository.ObjectId id)
public boolean isDrawn()
public boolean isDrawStep()
public void setDraw(boolean draw)
draw - True if you want the step to show itself on the canvas, False if you don't.public void setCopies(int c)
c - The number of copies.public int getCopies()
public void drawStep()
public void hideStep()
public boolean equals(Object obj)
public int compareTo(StepMeta o)
compareTo in interface Comparable<StepMeta>public boolean hasChanged()
public void setChanged(boolean ch)
public void setChanged()
public boolean chosesTargetSteps()
public void replaceMeta(StepMeta stepMeta)
public StepMetaInterface getStepMetaInterface()
public void setStepMetaInterface(StepMetaInterface stepMetaInterface)
public String getStepID()
public String getName()
getName in interface org.pentaho.di.core.CheckResultSourceInterfacegetName in interface ResourceHolderInterfacegetName in interface org.pentaho.di.shared.SharedObjectInterfacepublic void setName(String sname)
public String getDescription()
getDescription in interface org.pentaho.di.core.CheckResultSourceInterfacegetDescription in interface ResourceHolderInterfacepublic void setDescription(String description)
public void setSelected(boolean sel)
setSelected in interface org.pentaho.di.core.gui.GUIPositionInterfacepublic void flipSelected()
public boolean isSelected()
isSelected in interface org.pentaho.di.core.gui.GUIPositionInterfacepublic void setTerminator()
public void setTerminator(boolean t)
public boolean hasTerminator()
public void setLocation(int x,
                        int y)
setLocation in interface org.pentaho.di.core.gui.GUIPositionInterfacepublic void setLocation(org.pentaho.di.core.gui.Point loc)
setLocation in interface org.pentaho.di.core.gui.GUIPositionInterfacepublic org.pentaho.di.core.gui.Point getLocation()
getLocation in interface org.pentaho.di.core.gui.GUIPositionInterface@Deprecated public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info)
check(List, TransMeta, RowMetaInterface, String[], String[], RowMetaInterface, VariableSpace, Repository, IMetaStore)remarks - transMeta - prev - input - output - info - public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
public boolean isPartitioned()
public boolean isTargetPartitioned()
public StepPartitioningMeta getStepPartitioningMeta()
public void setStepPartitioningMeta(StepPartitioningMeta stepPartitioningMeta)
stepPartitioningMeta - the stepPartitioningMeta to setpublic ClusterSchema getClusterSchema()
public void setClusterSchema(ClusterSchema clusterSchema)
clusterSchema - the clusterSchema to setpublic boolean isDistributes()
public void setDistributes(boolean distributes)
distributes - the distributes to setpublic StepErrorMeta getStepErrorMeta()
public void setStepErrorMeta(StepErrorMeta stepErrorMeta)
stepErrorMeta - the error handling metadata for this steppublic static final StepMeta findStep(List<StepMeta> steps, org.pentaho.di.repository.ObjectId id)
steps - The List of steps to searchid - The ID of the steppublic static final StepMeta findStep(List<StepMeta> steps, String stepname)
steps - The List of steps to searchstepname - The name of the steppublic boolean supportsErrorHandling()
public boolean isDoingErrorHandling()
public boolean isSendingErrorRowsToStep(StepMeta targetStep)
public String getTypeId()
getTypeId in interface org.pentaho.di.core.CheckResultSourceInterfacegetTypeId in interface ResourceHolderInterfacepublic boolean isMapping()
public boolean isSingleThreader()
public boolean isEtlMetaInject()
public boolean isJobExecutor()
public boolean isMappingInput()
public boolean isMappingOutput()
public List<ResourceReference> getResourceDependencies(TransMeta transMeta)
@Deprecated public String exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws org.pentaho.di.core.exception.KettleException
exportResources(VariableSpace, Map, ResourceNamingInterface, Repository, IMetaStore)space - definitions - resourceNamingInterface - repository - org.pentaho.di.core.exception.KettleExceptionpublic String exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleException
ResourceExportInterfaceexportResources in interface ResourceExportInterfacespace - The variable space to resolve (environment) variables with.definitions - The map containing the filenames and contentresourceNamingInterface - The resource naming interface allows the object to name appropriatelyrepository - the repository object to load frommetaStore - the central metastore to load non-kettle specific metadata fromorg.pentaho.di.core.exception.KettleException - in case something goes wrong during the exportpublic List<RemoteStep> getRemoteInputSteps()
public void setRemoteInputSteps(List<RemoteStep> remoteInputSteps)
remoteInputSteps - the remoteInputSteps to setpublic List<RemoteStep> getRemoteOutputSteps()
public void setRemoteOutputSteps(List<RemoteStep> remoteOutputSteps)
remoteOutputSteps - the remoteOutputSteps to setpublic StepPartitioningMeta getTargetStepPartitioningMeta()
public void setTargetStepPartitioningMeta(StepPartitioningMeta targetStepPartitioningMeta)
targetStepPartitioningMeta - the targetStepPartitioningMeta to setpublic boolean isRepartitioning()
public String getHolderType()
ResourceHolderInterfacegetHolderType in interface ResourceHolderInterfacepublic boolean isClustered()
public void setStepID(String stepid)
stepid - public void setClusterSchemaName(String clusterSchemaName)
public void setParentTransMeta(TransMeta parentTransMeta)
public TransMeta getParentTransMeta()
public RowDistributionInterface getRowDistribution()
public void setRowDistribution(RowDistributionInterface rowDistribution)
public String getCopiesString()
public void setCopiesString(String copiesString)
copiesString - the copiesString to setpublic void setAttributesMap(Map<String,Map<String,String>> attributesMap)
setAttributesMap in interface org.pentaho.di.core.AttributesInterfacepublic Map<String,Map<String,String>> getAttributesMap()
getAttributesMap in interface org.pentaho.di.core.AttributesInterfacepublic void setAttribute(String groupName, String key, String value)
setAttribute in interface org.pentaho.di.core.AttributesInterfacepublic void setAttributes(String groupName, Map<String,String> attributes)
setAttributes in interface org.pentaho.di.core.AttributesInterfacepublic Map<String,String> getAttributes(String groupName)
getAttributes in interface org.pentaho.di.core.AttributesInterfacepublic String getAttribute(String groupName, String key)
getAttribute in interface org.pentaho.di.core.AttributesInterfacepublic boolean isMissing()