public class JobExecutorMeta extends BaseStepMeta implements StepMetaInterface, HasRepositoryInterface, HasRepositoryDirectories
attributes, databases, ioMeta, log, loggingObject, parentStepMeta, STEP_ATTRIBUTES_FILE
Constructor and Description |
---|
JobExecutorMeta() |
Modifier and Type | Method and Description |
---|---|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepMeta,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info,
VariableSpace space,
Repository repository,
org.pentaho.metastore.api.IMetaStore metaStore)
Checks the settings of this step and puts the findings in a remarks List.
|
boolean |
cleanAfterHopFromRemove()
Action remove hop from this step
|
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(VariableSpace space,
Map<String,ResourceDefinition> definitions,
ResourceNamingInterface resourceNamingInterface,
Repository repository,
org.pentaho.metastore.api.IMetaStore metaStore) |
String[] |
getDirectories()
If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories.
|
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() |
void |
getFields(RowMetaInterface row,
String origin,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space,
Repository repository,
org.pentaho.metastore.api.IMetaStore metaStore)
Gets the fields.
|
String |
getFileName() |
String |
getGroupField() |
String |
getGroupSize() |
String |
getGroupTime() |
String[] |
getInfoSteps() |
String |
getJobName() |
ObjectId |
getJobObjectId() |
JobExecutorParameters |
getMappingParameters() |
org.pentaho.metastore.api.IMetaStore |
getMetaStore() |
JobExecutorParameters |
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() |
String[] |
getResultRowsField() |
int[] |
getResultRowsLength() |
int[] |
getResultRowsPrecision() |
String |
getResultRowsTargetStep() |
StepMeta |
getResultRowsTargetStepMeta() |
int[] |
getResultRowsType() |
ObjectLocationSpecificationMethod |
getSpecificationMethod() |
ObjectLocationSpecificationMethod[] |
getSpecificationMethods()
If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s)
defining the type of an access to a referenced file.
|
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[] |
getTargetSteps() |
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() |
static JobMeta |
loadJobMeta(JobExecutorMeta executorMeta,
Repository rep,
org.pentaho.metastore.api.IMetaStore metaStore,
VariableSpace space) |
static JobMeta |
loadJobMeta(JobExecutorMeta executorMeta,
Repository rep,
VariableSpace space) |
Object |
loadReferencedObject(int index,
Repository rep,
org.pentaho.metastore.api.IMetaStore metaStore,
VariableSpace space)
Load the referenced object
|
void |
loadXML(Node stepnode,
List<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,
ObjectId id_step,
List<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,
ObjectId id_transformation,
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 |
setDirectories(String[] directories)
If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from
incoming String array.
|
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 |
setFileName(String fileName) |
void |
setGroupField(String groupField) |
void |
setGroupSize(String groupSize) |
void |
setGroupTime(String groupTime) |
void |
setJobName(String jobName) |
void |
setJobObjectId(ObjectId jobObjectId) |
void |
setMappingParameters(JobExecutorParameters mappingParameters) |
void |
setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore) |
void |
setParameters(JobExecutorParameters parameters) |
void |
setRepository(Repository repository) |
void |
setResultFilesFileNameField(String resultFilesFileNameField) |
void |
setResultFilesTargetStep(String resultFilesTargetStep) |
void |
setResultFilesTargetStepMeta(StepMeta resultFilesTargetStepMeta) |
void |
setResultRowsField(String[] resultRowsField) |
void |
setResultRowsLength(int[] resultRowsLength) |
void |
setResultRowsPrecision(int[] resultRowsPrecision) |
void |
setResultRowsTargetStep(String resultRowsTargetStep) |
void |
setResultRowsTargetStepMeta(StepMeta resultRowsTargetStepMeta) |
void |
setResultRowsType(int[] resultRowsType) |
void |
setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod) |
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, 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, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, readRep, readRep, saveRep, setChanged, setChanged, setParentStepMeta, supportsErrorHandling
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
analyseImpact, analyseImpact, cancelQueries, check, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getSQLStatements, getStepMetaInjectionInterface, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasChanged, loadXML, passDataToServletOutput, readRep, saveRep, setChanged, setParentStepMeta, supportsErrorHandling
public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void loadXML(Node stepnode, List<DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
loadXML
in class BaseStepMeta
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata fromKettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_step, List<DatabaseMeta> databases) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
readRep
in class BaseStepMeta
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- The databases to referenceKettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
saveRep
in class BaseStepMeta
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_step
- The step IDKettleException
- When an unexpected error occurred (database, network, etc)public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(RowMetaInterface row, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- the input row meta that is modified in this method to reflect the output row metadata of the steporigin
- 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 fieldsKettleStepException
- the kettle step exceptionpublic String[] getInfoSteps()
public String[] getTargetSteps()
public static final JobMeta loadJobMeta(JobExecutorMeta executorMeta, Repository rep, VariableSpace space) throws KettleException
KettleException
public static final JobMeta loadJobMeta(JobExecutorMeta executorMeta, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space) throws KettleException
KettleException
public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
StepMetaInterface
check
in interface StepMetaInterface
check
in class BaseStepMeta
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 fieldspublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
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 gettr
- The transformation infotrans
- The launching transformationpublic List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
BaseStepMeta
getResourceDependencies
in interface StepMetaInterface
getResourceDependencies
in class BaseStepMeta
public String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- 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.KettleException
public StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public StepIOMetaInterface getStepIOMeta()
BaseStepMeta
getStepIOMeta
in interface StepMetaInterface
getStepIOMeta
in class BaseStepMeta
public void handleStreamSelection(StreamInterface stream)
handleStreamSelection
in interface StepMetaInterface
handleStreamSelection
in class BaseStepMeta
stream
- The optional stream to handle.public void resetStepIoMeta()
StepIOMeta
so it is recreated when it is next accessed.resetStepIoMeta
in interface StepMetaInterface
resetStepIoMeta
in class BaseStepMeta
public void searchInfoAndTargetSteps(List<StepMeta> steps)
BaseStepMeta
searchInfoAndTargetSteps
in interface StepMetaInterface
searchInfoAndTargetSteps
in class BaseStepMeta
steps
- the steps to referencepublic TransMeta.TransformationType[] getSupportedTransformationTypes()
getSupportedTransformationTypes
in interface StepMetaInterface
getSupportedTransformationTypes
in class BaseStepMeta
public boolean hasRepositoryReferences()
hasRepositoryReferences
in interface StepMetaInterface
hasRepositoryReferences
in class BaseStepMeta
public void lookupRepositoryReferences(Repository repository) throws KettleException
BaseStepMeta
lookupRepositoryReferences
in interface StepMetaInterface
lookupRepositoryReferences
in class BaseStepMeta
repository
- the repository to reference.KettleException
public String getDirectoryPath()
public void setDirectoryPath(String directoryPath)
directoryPath
- the directoryPath to setpublic String[] getDirectories()
HasRepositoryDirectories
getDirectories
in interface HasRepositoryDirectories
public void setDirectories(String[] directories)
HasRepositoryDirectories
setDirectories
in interface HasRepositoryDirectories
directories
- Array of updated rep directories to setpublic String getFileName()
public void setFileName(String fileName)
fileName
- the fileName to setpublic JobExecutorParameters getMappingParameters()
public void setMappingParameters(JobExecutorParameters mappingParameters)
mappingParameters
- the mappingParameters to setpublic Repository getRepository()
getRepository
in interface HasRepositoryInterface
public void setRepository(Repository repository)
setRepository
in interface HasRepositoryInterface
repository
- the repository to setpublic ObjectLocationSpecificationMethod getSpecificationMethod()
public ObjectLocationSpecificationMethod[] getSpecificationMethods()
HasRepositoryDirectories
getSpecificationMethods
in interface HasRepositoryDirectories
public void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
specificationMethod
- the specificationMethod to setpublic String getJobName()
public void setJobName(String jobName)
jobName
- the jobName to setpublic ObjectId getJobObjectId()
public void setJobObjectId(ObjectId jobObjectId)
jobObjectId
- the jobObjectId to setpublic JobExecutorParameters getParameters()
public void setParameters(JobExecutorParameters 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 getResultRowsTargetStep()
public void setResultRowsTargetStep(String resultRowsTargetStep)
resultRowsTargetStep
- the resultRowsTargetStep to setpublic String[] getResultRowsField()
public void setResultRowsField(String[] resultRowsField)
resultRowsField
- the resultRowsField to setpublic int[] getResultRowsType()
public void setResultRowsType(int[] resultRowsType)
resultRowsType
- the resultRowsType to setpublic int[] getResultRowsLength()
public void setResultRowsLength(int[] resultRowsLength)
resultRowsLength
- the resultRowsLength to setpublic int[] getResultRowsPrecision()
public void setResultRowsPrecision(int[] resultRowsPrecision)
resultRowsPrecision
- the resultRowsPrecision to setpublic String getResultFilesTargetStep()
public void setResultFilesTargetStep(String resultFilesTargetStep)
resultFilesTargetStep
- the resultFilesTargetStep to setpublic StepMeta getResultRowsTargetStepMeta()
public void setResultRowsTargetStepMeta(StepMeta resultRowsTargetStepMeta)
resultRowsTargetStepMeta
- the resultRowsTargetStepMeta to setpublic StepMeta getResultFilesTargetStepMeta()
public void setResultFilesTargetStepMeta(StepMeta resultFilesTargetStepMeta)
resultFilesTargetStepMeta
- the resultFilesTargetStepMeta 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()
BaseStepMeta
excludeFromCopyDistributeVerification
in interface StepMetaInterface
excludeFromCopyDistributeVerification
in class BaseStepMeta
public 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 StepMetaInterface
getReferencedObjectDescriptions
in class BaseStepMeta
public boolean[] isReferencedObjectEnabled()
isReferencedObjectEnabled
in interface StepMetaInterface
isReferencedObjectEnabled
in class BaseStepMeta
public Object loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space) throws KettleException
loadReferencedObject
in interface StepMetaInterface
loadReferencedObject
in class BaseStepMeta
index
- the object index to loadrep
- the repositorymetaStore
- the metaStorespace
- the variable space to useKettleException
public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)
public org.pentaho.metastore.api.IMetaStore getMetaStore()
public boolean cleanAfterHopFromRemove()
StepMetaInterface
cleanAfterHopFromRemove
in interface StepMetaInterface
Copyright © 2018 Hitachi Vantara. All rights reserved.