public class TransExecutorMeta extends BaseStepMeta implements StepMetaInterface, HasRepositoryInterface
loggingObject, STEP_ATTRIBUTES_FILE| Constructor and Description | 
|---|
TransExecutorMeta()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
allocate(int nrFields)  | 
void | 
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
     TransMeta transMeta,
     StepMeta stepinfo,
     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)
Checks the settings of this step and puts the findings in a remarks List. 
 | 
Object | 
clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc. 
 | 
boolean | 
excludeFromCopyDistributeVerification()
This method is added to exclude certain steps from copy/distribute checking. 
 | 
String | 
exportResources(org.pentaho.di.core.variables.VariableSpace space,
               Map<String,ResourceDefinition> definitions,
               ResourceNamingInterface resourceNamingInterface,
               Repository repository,
               org.pentaho.metastore.api.IMetaStore metaStore)  | 
String | 
getDirectoryPath()  | 
String | 
getExecutionExitStatusField()  | 
String | 
getExecutionFilesRetrievedField()  | 
String | 
getExecutionLinesDeletedField()  | 
String | 
getExecutionLinesInputField()  | 
String | 
getExecutionLinesOutputField()  | 
String | 
getExecutionLinesReadField()  | 
String | 
getExecutionLinesRejectedField()  | 
String | 
getExecutionLinesUpdatedField()  | 
String | 
getExecutionLinesWrittenField()  | 
String | 
getExecutionLogChannelIdField()  | 
String | 
getExecutionLogTextField()  | 
String | 
getExecutionNrErrorsField()  | 
String | 
getExecutionResultField()  | 
String | 
getExecutionResultTargetStep()  | 
StepMeta | 
getExecutionResultTargetStepMeta()  | 
String | 
getExecutionTimeField()  | 
String | 
getExecutorsOutputStep()  | 
StepMeta | 
getExecutorsOutputStepMeta()  | 
void | 
getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta,
         String name,
         org.pentaho.di.core.row.RowMetaInterface[] info,
         StepMeta nextStep,
         org.pentaho.di.core.variables.VariableSpace space,
         Repository repository,
         org.pentaho.metastore.api.IMetaStore metaStore)
Gets the fields. 
 | 
String | 
getFileName()  | 
String | 
getGroupField()  | 
String | 
getGroupSize()  | 
String | 
getGroupTime()  | 
String[] | 
getInfoSteps()  | 
TransExecutorParameters | 
getMappingParameters()  | 
org.pentaho.metastore.api.IMetaStore | 
getMetaStore()  | 
String[] | 
getOutputRowsField()  | 
int[] | 
getOutputRowsLength()  | 
int[] | 
getOutputRowsPrecision()  | 
String | 
getOutputRowsSourceStep()  | 
StepMeta | 
getOutputRowsSourceStepMeta()  | 
int[] | 
getOutputRowsType()  | 
TransExecutorParameters | 
getParameters()  | 
String[] | 
getReferencedObjectDescriptions()  | 
Repository | 
getRepository()  | 
List<ResourceReference> | 
getResourceDependencies(TransMeta transMeta,
                       StepMeta stepInfo)
Get a list of all the resource dependencies that the step is depending on. 
 | 
String | 
getResultFilesFileNameField()  | 
String | 
getResultFilesTargetStep()  | 
StepMeta | 
getResultFilesTargetStepMeta()  | 
org.pentaho.di.core.ObjectLocationSpecificationMethod | 
getSpecificationMethod()  | 
StepInterface | 
getStep(StepMeta stepMeta,
       StepDataInterface stepDataInterface,
       int cnr,
       TransMeta tr,
       Trans trans)
Get the executing step, needed by Trans to launch a step. 
 | 
StepDataInterface | 
getStepData()
Get a new instance of the appropriate data class. 
 | 
StepIOMetaInterface | 
getStepIOMeta()
Returns the Input/Output metadata for this step. 
 | 
TransMeta.TransformationType[] | 
getSupportedTransformationTypes()  | 
String | 
getTransName()  | 
org.pentaho.di.repository.ObjectId | 
getTransObjectId()  | 
String | 
getXML()
Produces the XML string that describes this step's information. 
 | 
void | 
handleStreamSelection(StreamInterface stream)
When an optional stream is selected, this method is called to handled the ETL metadata implications of that. 
 | 
boolean | 
hasRepositoryReferences()  | 
boolean[] | 
isReferencedObjectEnabled()  | 
Object | 
loadReferencedObject(int index,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.core.variables.VariableSpace space)
Load the referenced object 
 | 
static TransMeta | 
loadTransMeta(TransExecutorMeta executorMeta,
             Repository rep,
             org.pentaho.metastore.api.IMetaStore metaStore,
             org.pentaho.di.core.variables.VariableSpace space)  | 
static TransMeta | 
loadTransMeta(TransExecutorMeta executorMeta,
             Repository rep,
             org.pentaho.di.core.variables.VariableSpace space)
Deprecated.  
 | 
void | 
loadXML(Node stepnode,
       List<org.pentaho.di.core.database.DatabaseMeta> databases,
       org.pentaho.metastore.api.IMetaStore metaStore)
Load the values for this step from an XML Node 
 | 
void | 
lookupRepositoryReferences(Repository repository)
Look up the references after import 
 | 
void | 
readRep(Repository rep,
       org.pentaho.metastore.api.IMetaStore metaStore,
       org.pentaho.di.repository.ObjectId id_step,
       List<org.pentaho.di.core.database.DatabaseMeta> databases)
Read the steps information from a Kettle repository 
 | 
void | 
resetStepIoMeta()
Remove the cached  
StepIOMeta so it is recreated when it is next accessed. | 
void | 
saveRep(Repository rep,
       org.pentaho.metastore.api.IMetaStore metaStore,
       org.pentaho.di.repository.ObjectId id_transformation,
       org.pentaho.di.repository.ObjectId id_step)
Save the steps data into a Kettle repository 
 | 
void | 
searchInfoAndTargetSteps(List<StepMeta> steps)
Change step names into step objects to allow them to be name-changed etc. 
 | 
void | 
setDefault()
Set default values 
 | 
void | 
setDirectoryPath(String directoryPath)  | 
void | 
setExecutionExitStatusField(String executionExitStatusField)  | 
void | 
setExecutionFilesRetrievedField(String executionFilesRetrievedField)  | 
void | 
setExecutionLinesDeletedField(String executionLinesDeletedField)  | 
void | 
setExecutionLinesInputField(String executionLinesInputField)  | 
void | 
setExecutionLinesOutputField(String executionLinesOutputField)  | 
void | 
setExecutionLinesReadField(String executionLinesReadField)  | 
void | 
setExecutionLinesRejectedField(String executionLinesRejectedField)  | 
void | 
setExecutionLinesUpdatedField(String executionLinesUpdatedField)  | 
void | 
setExecutionLinesWrittenField(String executionLinesWrittenField)  | 
void | 
setExecutionLogChannelIdField(String executionLogChannelIdField)  | 
void | 
setExecutionLogTextField(String executionLogTextField)  | 
void | 
setExecutionNrErrorsField(String executionNrErrorsField)  | 
void | 
setExecutionResultField(String executionResultField)  | 
void | 
setExecutionResultTargetStep(String executionResultTargetStep)  | 
void | 
setExecutionResultTargetStepMeta(StepMeta executionResultTargetStepMeta)  | 
void | 
setExecutionTimeField(String executionTimeField)  | 
void | 
setExecutorsOutputStep(String executorsOutputStep)  | 
void | 
setExecutorsOutputStepMeta(StepMeta executorsOutputStepMeta)  | 
void | 
setFileName(String fileName)  | 
void | 
setGroupField(String groupField)  | 
void | 
setGroupSize(String groupSize)  | 
void | 
setGroupTime(String groupTime)  | 
void | 
setMappingParameters(TransExecutorParameters mappingParameters)  | 
void | 
setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)  | 
void | 
setOutputRowsField(String[] outputRowsField)  | 
void | 
setOutputRowsLength(int[] outputRowsLength)  | 
void | 
setOutputRowsPrecision(int[] outputRowsPrecision)  | 
void | 
setOutputRowsSourceStep(String outputRowsSourceStep)  | 
void | 
setOutputRowsSourceStepMeta(StepMeta outputRowsSourceStepMeta)  | 
void | 
setOutputRowsType(int[] outputRowsType)  | 
void | 
setParameters(TransExecutorParameters parameters)  | 
void | 
setRepository(Repository repository)  | 
void | 
setResultFilesFileNameField(String resultFilesFileNameField)  | 
void | 
setResultFilesTargetStep(String resultFilesTargetStep)  | 
void | 
setResultFilesTargetStepMeta(StepMeta resultFilesTargetStepMeta)  | 
void | 
setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)  | 
void | 
setTransName(String transName)  | 
void | 
setTransObjectId(org.pentaho.di.repository.ObjectId transObjectId)  | 
analyseImpact, analyseImpact, cancelQueries, check, check, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepMetaInjectionInterface, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, hasChanged, isBasic, isDebug, isDetailed, isRowLevel, loadReferencedObject, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, readRep, readRep, saveRep, setChanged, setChanged, setParentStepMeta, supportsErrorHandlingequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitanalyseImpact, analyseImpact, cancelQueries, check, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getSQLStatements, getStepMetaInjectionInterface, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasChanged, loadXML, readRep, saveRep, setChanged, setParentStepMeta, supportsErrorHandlingpublic void allocate(int nrFields)
public Object clone()
StepMetaInterfaceclone in interface StepMetaInterfaceclone in class BaseStepMetapublic String getXML()
BaseStepMetagetXML in interface StepMetaInterfacegetXML in class BaseStepMetapublic void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException
StepMetaInterfaceloadXML in interface StepMetaInterfaceloadXML in class BaseStepMetastepnode - the Node to get the info fromdatabases - The available list of databases to reference tometaStore - the metastore to optionally load external reference metadata fromorg.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException
StepMetaInterfacereadRep in interface StepMetaInterfacereadRep in class BaseStepMetarep - The repository to read frommetaStore - The MetaStore to read external information fromid_step - The step IDdatabases - The databases to referenceorg.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException
StepMetaInterfacesaveRep in interface StepMetaInterfacesaveRep in class BaseStepMetarep - The Kettle repository to save tometaStore - the metaStore to optionally write toid_transformation - The transformation IDid_step - The step IDorg.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)public void setDefault()
StepMetaInterfacesetDefault in interface StepMetaInterfacepublic void getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta,
                      String name,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException
BaseStepMetagetFields in interface StepMetaInterfacegetFields in class BaseStepMetainputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the stepname - Name of the step to use as input for the origin field in the valuesinfo - Fields used as extra lookup informationnextStep - the next step that is targetedspace - the space The variable space to use to replace variablesrepository - the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore - the MetaStore to use to load additional external data or metadata impacting the output fieldsorg.pentaho.di.core.exception.KettleStepException - the kettle step exceptionpublic String[] getInfoSteps()
@Deprecated public static TransMeta loadTransMeta(TransExecutorMeta executorMeta, Repository rep, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleExceptionpublic static TransMeta loadTransMeta(TransExecutorMeta executorMeta, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleExceptionpublic void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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)
StepMetaInterfacecheck in interface StepMetaInterfacecheck in class BaseStepMetaremarks - The list to put the remarks in @see org.pentaho.di.core.CheckResultstepinfo - The stepMeta to help checkingprev - The fields coming from the previous stepinput - The input step namesoutput - The output step namesinfo - The fields that are used as information by the stepspace - the variable space to resolve variable expressions withrepository - the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore - the MetaStore to use to load additional external data or metadata impacting the output fieldspublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
StepMetaInterfacegetStep in interface StepMetaInterfacestepMeta - The step infostepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections,
          etc.cnr - The copy nr to gettr - The transformation infotrans - The launching transformationpublic List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
BaseStepMetagetResourceDependencies in interface StepMetaInterfacegetResourceDependencies in class BaseStepMetapublic 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
exportResources in interface StepMetaInterfaceexportResources in class BaseStepMetaspace - the variable space to userepository - The repository to optionally load other resources from (to be converted to XML)metaStore - the metaStore in which non-kettle metadata could reside.org.pentaho.di.core.exception.KettleExceptionpublic StepDataInterface getStepData()
StepMetaInterfacegetStepData in interface StepMetaInterfacepublic StepIOMetaInterface getStepIOMeta()
BaseStepMetagetStepIOMeta in interface StepMetaInterfacegetStepIOMeta in class BaseStepMetapublic void handleStreamSelection(StreamInterface stream)
handleStreamSelection in interface StepMetaInterfacehandleStreamSelection in class BaseStepMetastream - The optional stream to handle.public void resetStepIoMeta()
StepIOMeta so it is recreated when it is next accessed.resetStepIoMeta in interface StepMetaInterfaceresetStepIoMeta in class BaseStepMetapublic void searchInfoAndTargetSteps(List<StepMeta> steps)
BaseStepMetasearchInfoAndTargetSteps in interface StepMetaInterfacesearchInfoAndTargetSteps in class BaseStepMetasteps - the steps to referencepublic TransMeta.TransformationType[] getSupportedTransformationTypes()
getSupportedTransformationTypes in interface StepMetaInterfacegetSupportedTransformationTypes in class BaseStepMetapublic boolean hasRepositoryReferences()
hasRepositoryReferences in interface StepMetaInterfacehasRepositoryReferences in class BaseStepMetapublic void lookupRepositoryReferences(Repository repository) throws org.pentaho.di.core.exception.KettleException
BaseStepMetalookupRepositoryReferences in interface StepMetaInterfacelookupRepositoryReferences in class BaseStepMetarepository - the repository to reference.org.pentaho.di.core.exception.KettleExceptionpublic String getDirectoryPath()
public void setDirectoryPath(String directoryPath)
directoryPath - the directoryPath to setpublic String getFileName()
public void setFileName(String fileName)
fileName - the fileName to setpublic TransExecutorParameters getMappingParameters()
public void setMappingParameters(TransExecutorParameters mappingParameters)
mappingParameters - the mappingParameters to setpublic Repository getRepository()
getRepository in interface HasRepositoryInterfacepublic void setRepository(Repository repository)
setRepository in interface HasRepositoryInterfacerepository - the repository to setpublic org.pentaho.di.core.ObjectLocationSpecificationMethod getSpecificationMethod()
public void setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)
specificationMethod - the specificationMethod to setpublic String getTransName()
public void setTransName(String transName)
transName - the transName to setpublic org.pentaho.di.repository.ObjectId getTransObjectId()
public void setTransObjectId(org.pentaho.di.repository.ObjectId transObjectId)
transObjectId - the transObjectId to setpublic TransExecutorParameters getParameters()
public void setParameters(TransExecutorParameters parameters)
parameters - the parameters to setpublic String getExecutionTimeField()
public void setExecutionTimeField(String executionTimeField)
executionTimeField - the executionTimeField to setpublic String getExecutionResultField()
public void setExecutionResultField(String executionResultField)
executionResultField - the executionResultField to setpublic String getExecutionNrErrorsField()
public void setExecutionNrErrorsField(String executionNrErrorsField)
executionNrErrorsField - the executionNrErrorsField to setpublic String getExecutionLinesReadField()
public void setExecutionLinesReadField(String executionLinesReadField)
executionLinesReadField - the executionLinesReadField to setpublic String getExecutionLinesWrittenField()
public void setExecutionLinesWrittenField(String executionLinesWrittenField)
executionLinesWrittenField - the executionLinesWrittenField to setpublic String getExecutionLinesInputField()
public void setExecutionLinesInputField(String executionLinesInputField)
executionLinesInputField - the executionLinesInputField to setpublic String getExecutionLinesOutputField()
public void setExecutionLinesOutputField(String executionLinesOutputField)
executionLinesOutputField - the executionLinesOutputField to setpublic String getExecutionLinesRejectedField()
public void setExecutionLinesRejectedField(String executionLinesRejectedField)
executionLinesRejectedField - the executionLinesRejectedField to setpublic String getExecutionLinesUpdatedField()
public void setExecutionLinesUpdatedField(String executionLinesUpdatedField)
executionLinesUpdatedField - the executionLinesUpdatedField to setpublic String getExecutionLinesDeletedField()
public void setExecutionLinesDeletedField(String executionLinesDeletedField)
executionLinesDeletedField - the executionLinesDeletedField to setpublic String getExecutionFilesRetrievedField()
public void setExecutionFilesRetrievedField(String executionFilesRetrievedField)
executionFilesRetrievedField - the executionFilesRetrievedField to setpublic String getExecutionExitStatusField()
public void setExecutionExitStatusField(String executionExitStatusField)
executionExitStatusField - the executionExitStatusField to setpublic String getExecutionLogTextField()
public void setExecutionLogTextField(String executionLogTextField)
executionLogTextField - the executionLogTextField to setpublic String getExecutionLogChannelIdField()
public void setExecutionLogChannelIdField(String executionLogChannelIdField)
executionLogChannelIdField - the executionLogChannelIdField to setpublic String getGroupSize()
public void setGroupSize(String groupSize)
groupSize - the groupSize to setpublic String getGroupField()
public void setGroupField(String groupField)
groupField - the groupField to setpublic String getGroupTime()
public void setGroupTime(String groupTime)
groupTime - the groupTime to setpublic boolean excludeFromCopyDistributeVerification()
BaseStepMetaexcludeFromCopyDistributeVerification in interface StepMetaInterfaceexcludeFromCopyDistributeVerification in class BaseStepMetapublic String getExecutionResultTargetStep()
public void setExecutionResultTargetStep(String executionResultTargetStep)
executionResultTargetStep - the executionResultTargetStep to setpublic StepMeta getExecutionResultTargetStepMeta()
public void setExecutionResultTargetStepMeta(StepMeta executionResultTargetStepMeta)
executionResultTargetStepMeta - the executionResultTargetStepMeta to setpublic String getResultFilesFileNameField()
public void setResultFilesFileNameField(String resultFilesFileNameField)
resultFilesFileNameField - the resultFilesFileNameField to setpublic String[] getReferencedObjectDescriptions()
getReferencedObjectDescriptions in interface StepMetaInterfacegetReferencedObjectDescriptions in class BaseStepMetapublic boolean[] isReferencedObjectEnabled()
isReferencedObjectEnabled in interface StepMetaInterfaceisReferencedObjectEnabled in class BaseStepMetapublic Object loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
loadReferencedObject in interface StepMetaInterfaceloadReferencedObject in class BaseStepMetaindex - the object index to loadrep - the repositoryspace - the variable space to usemetaStore - the MetaStore to useorg.pentaho.di.core.exception.KettleExceptionpublic org.pentaho.metastore.api.IMetaStore getMetaStore()
public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)
public String getOutputRowsSourceStep()
public void setOutputRowsSourceStep(String outputRowsSourceStep)
public StepMeta getOutputRowsSourceStepMeta()
public void setOutputRowsSourceStepMeta(StepMeta outputRowsSourceStepMeta)
public String[] getOutputRowsField()
public void setOutputRowsField(String[] outputRowsField)
public int[] getOutputRowsType()
public void setOutputRowsType(int[] outputRowsType)
public int[] getOutputRowsLength()
public void setOutputRowsLength(int[] outputRowsLength)
public int[] getOutputRowsPrecision()
public void setOutputRowsPrecision(int[] outputRowsPrecision)
public String getResultFilesTargetStep()
public void setResultFilesTargetStep(String resultFilesTargetStep)
public StepMeta getResultFilesTargetStepMeta()
public void setResultFilesTargetStepMeta(StepMeta resultFilesTargetStepMeta)
public String getExecutorsOutputStep()
public void setExecutorsOutputStep(String executorsOutputStep)
public StepMeta getExecutorsOutputStepMeta()
public void setExecutorsOutputStepMeta(StepMeta executorsOutputStepMeta)