Class ExecProcessMeta
- java.lang.Object
-
- org.pentaho.di.trans.step.BaseStepMeta
-
- org.pentaho.di.trans.steps.execprocess.ExecProcessMeta
-
- All Implemented Interfaces:
Cloneable
,StepAttributesInterface
,StepMetaInterface
public class ExecProcessMeta extends BaseStepMeta implements StepMetaInterface
-
-
Field Summary
Fields Modifier and Type Field Description String
outputLineDelimiter
Output Line Delimiter - defaults to empty string for backward compatibility-
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE
-
-
Constructor Summary
Constructors Constructor Description ExecProcessMeta()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
allocate(int argumentCount)
void
check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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.String[]
getArgumentFieldNames()
String
getErrorFieldName()
String
getExitValueFieldName()
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
getOutputLineDelimiter()
String
getProcessField()
String
getResultFieldName()
StepInterface
getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
Get the executing step, needed by Trans to launch a step.StepDataInterface
getStepData()
Get a new instance of the appropriate data class.String
getXML()
Produces the XML string that describes this step's information.boolean
isArgumentsInFields()
boolean
isFailWhenNotSuccess()
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 Nodevoid
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 repositoryvoid
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 repositoryvoid
setArgumentFieldNames(String[] argumentFieldNames)
void
setArgumentsInFields(boolean argumentsInFields)
void
setDefault()
Set default valuesvoid
setErrorFieldName(String errorfieldname)
void
setExitValueFieldName(String exitvaluefieldname)
void
setFailWhenNotSuccess(boolean failwhennotsuccess)
void
setFailWhentNoSuccess(boolean failwhennotsuccess)
Deprecated.due to method name typovoid
setOutputLineDelimiter(String value)
void
setProcessField(String processfield)
void
setResultFieldName(String resultfieldname)
boolean
supportsErrorHandling()
-
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta
-
-
-
-
Field Detail
-
outputLineDelimiter
public String outputLineDelimiter
Output Line Delimiter - defaults to empty string for backward compatibility
-
-
Method Detail
-
allocate
public void allocate(int argumentCount)
-
getProcessField
public String getProcessField()
- Returns:
- Returns the processfield.
-
setProcessField
public void setProcessField(String processfield)
- Parameters:
processfield
- The processfield to set.
-
getResultFieldName
public String getResultFieldName()
- Returns:
- Returns the resultName.
-
setResultFieldName
public void setResultFieldName(String resultfieldname)
- Parameters:
resultfieldname
- The resultfieldname to set.
-
getErrorFieldName
public String getErrorFieldName()
- Returns:
- Returns the errorfieldname.
-
setErrorFieldName
public void setErrorFieldName(String errorfieldname)
- Parameters:
errorfieldname
- The errorfieldname to set.
-
getExitValueFieldName
public String getExitValueFieldName()
- Returns:
- Returns the exitvaluefieldname.
-
setExitValueFieldName
public void setExitValueFieldName(String exitvaluefieldname)
- Parameters:
exitvaluefieldname
- The exitvaluefieldname to set.
-
isFailWhenNotSuccess
public boolean isFailWhenNotSuccess()
- Returns:
- Returns the failwhennotsuccess.
-
setFailWhentNoSuccess
@Deprecated public void setFailWhentNoSuccess(boolean failwhennotsuccess)
Deprecated.due to method name typo- Parameters:
failwhennotsuccess
- The failwhennotsuccess to set.
-
setFailWhenNotSuccess
public void setFailWhenNotSuccess(boolean failwhennotsuccess)
- Parameters:
failwhennotsuccess
- The failwhennotsuccess to set.
-
loadXML
public 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
Description copied from interface:StepMetaInterface
Load the values for this step from an XML Node- Specified by:
loadXML
in interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseStepMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata from- Throws:
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)
-
clone
public Object clone()
Description copied from interface:StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.- Specified by:
clone
in interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
setDefault
public void setDefault()
Description copied from interface:StepMetaInterface
Set default values- Specified by:
setDefault
in interfaceStepMetaInterface
-
getFields
public 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
Description copied from class:BaseStepMeta
Gets the fields.- Specified by:
getFields
in interfaceStepMetaInterface
- Overrides:
getFields
in classBaseStepMeta
- Parameters:
inputRowMeta
- 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 fields- Throws:
org.pentaho.di.core.exception.KettleStepException
- the kettle step exception
-
getXML
public String getXML()
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseStepMeta
- Returns:
- String containing the XML describing this step.
-
readRep
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
Description copied from interface:StepMetaInterface
Read the steps information from a Kettle repository- Specified by:
readRep
in interfaceStepMetaInterface
- Overrides:
readRep
in classBaseStepMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- The databases to reference- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
saveRep
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
Description copied from interface:StepMetaInterface
Save the steps data into a Kettle repository- Specified by:
saveRep
in interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseStepMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_step
- The step ID- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
check
public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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)
Description copied from interface:StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.- Specified by:
check
in interfaceStepMetaInterface
- Overrides:
check
in classBaseStepMeta
- Parameters:
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- 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 fields
-
getStep
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
Description copied from interface:StepMetaInterface
Get the executing step, needed by Trans to launch a step.- Specified by:
getStep
in interfaceStepMetaInterface
- Parameters:
stepMeta
- 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 gettransMeta
- The transformation infotrans
- The launching transformation
-
getStepData
public StepDataInterface getStepData()
Description copied from interface:StepMetaInterface
Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.- Specified by:
getStepData
in interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
supportsErrorHandling
public boolean supportsErrorHandling()
- Specified by:
supportsErrorHandling
in interfaceStepMetaInterface
- Overrides:
supportsErrorHandling
in classBaseStepMeta
- Returns:
- true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.
-
setOutputLineDelimiter
public void setOutputLineDelimiter(String value)
-
getOutputLineDelimiter
public String getOutputLineDelimiter()
-
isArgumentsInFields
public boolean isArgumentsInFields()
-
setArgumentsInFields
public void setArgumentsInFields(boolean argumentsInFields)
-
getArgumentFieldNames
public String[] getArgumentFieldNames()
-
setArgumentFieldNames
public void setArgumentFieldNames(String[] argumentFieldNames)
-
-