Package org.apache.hop.pipeline.transforms.pipelineexecutor

Class PipelineExecutorMeta

  • All Implemented Interfaces:
    Cloneable, org.apache.hop.pipeline.ISubPipelineAwareMeta, org.apache.hop.pipeline.transform.ITransformMeta
    @Transform(id="PipelineExecutor",
           image="ui/images/pipelineexecutor.svg",
           name="i18n::PipelineExecutor.Name",
           description="i18n::PipelineExecutor.Description",
           categoryDescription="i18n:org.apache.hop.pipeline.transform:BaseTransform.Category.Flow",
           documentationUrl="/pipeline/transforms/pipelineexecutor.html",
           keywords="i18n::PipelineExecutorMeta.keyword")
public class PipelineExecutorMeta
extends org.apache.hop.pipeline.TransformWithMappingMeta<PipelineExecutor,​PipelineExecutorData>
implements org.apache.hop.pipeline.ISubPipelineAwareMeta
    Meta-data for the Pipeline Executor transform.

    • Constructor Detail

      • PipelineExecutorMeta

        public PipelineExecutorMeta()

    • Method Detail

      • allocate

        public void allocate​(int nrFields)

      • clone

        public Object clone()
        Specified by:
        clone in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        clone in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • getXml

        public String getXml()
        Specified by:
        getXml in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        getXml in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • setDefault

        public void setDefault()
        Specified by:
        setDefault in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        setDefault in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • getInfoTransforms

        public String[] getInfoTransforms()

      • getResourceDependencies

        public List<org.apache.hop.resource.ResourceReference> getResourceDependencies​(IVariables variables,
                                                                               org.apache.hop.pipeline.transform.TransformMeta transformMeta)
        Specified by:
        getResourceDependencies in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        getResourceDependencies in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • getTransformIOMeta

        public org.apache.hop.pipeline.transform.ITransformIOMeta getTransformIOMeta()
        Specified by:
        getTransformIOMeta in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        getTransformIOMeta in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • handleStreamSelection

        public void handleStreamSelection​(org.apache.hop.pipeline.transform.stream.IStream stream)
        When an optional stream is selected, this method is called to handled the ETL metadata implications of that.
        Specified by:
        handleStreamSelection in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        handleStreamSelection in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>
        Parameters:
        stream - The optional stream to handle.

      • resetTransformIoMeta

        public void resetTransformIoMeta()
        Remove the cached TransformIOMeta so it is recreated when it is next accessed.
        Specified by:
        resetTransformIoMeta in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        resetTransformIoMeta in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • searchInfoAndTargetTransforms

        public void searchInfoAndTargetTransforms​(List<org.apache.hop.pipeline.transform.TransformMeta> transforms)
        Specified by:
        searchInfoAndTargetTransforms in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        searchInfoAndTargetTransforms in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • getSupportedPipelineTypes

        public org.apache.hop.pipeline.PipelineMeta.PipelineType[] getSupportedPipelineTypes()
        Overrides:
        getSupportedPipelineTypes in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • setMappingParameters

        public void setMappingParameters​(PipelineExecutorParameters mappingParameters)
        Parameters:
        mappingParameters - the mappingParameters to set

      • setParameters

        public void setParameters​(PipelineExecutorParameters parameters)
        Parameters:
        parameters - the parameters to set

      • getExecutionTimeField

        public String getExecutionTimeField()
        Returns:
        the executionTimeField

      • setExecutionTimeField

        public void setExecutionTimeField​(String executionTimeField)
        Parameters:
        executionTimeField - the executionTimeField to set

      • getExecutionResultField

        public String getExecutionResultField()
        Returns:
        the executionResultField

      • setExecutionResultField

        public void setExecutionResultField​(String executionResultField)
        Parameters:
        executionResultField - the executionResultField to set

      • getExecutionNrErrorsField

        public String getExecutionNrErrorsField()
        Returns:
        the executionNrErrorsField

      • setExecutionNrErrorsField

        public void setExecutionNrErrorsField​(String executionNrErrorsField)
        Parameters:
        executionNrErrorsField - the executionNrErrorsField to set

      • getExecutionLinesReadField

        public String getExecutionLinesReadField()
        Returns:
        the executionLinesReadField

      • setExecutionLinesReadField

        public void setExecutionLinesReadField​(String executionLinesReadField)
        Parameters:
        executionLinesReadField - the executionLinesReadField to set

      • getExecutionLinesWrittenField

        public String getExecutionLinesWrittenField()
        Returns:
        the executionLinesWrittenField

      • setExecutionLinesWrittenField

        public void setExecutionLinesWrittenField​(String executionLinesWrittenField)
        Parameters:
        executionLinesWrittenField - the executionLinesWrittenField to set

      • getExecutionLinesInputField

        public String getExecutionLinesInputField()
        Returns:
        the executionLinesInputField

      • setExecutionLinesInputField

        public void setExecutionLinesInputField​(String executionLinesInputField)
        Parameters:
        executionLinesInputField - the executionLinesInputField to set

      • getExecutionLinesOutputField

        public String getExecutionLinesOutputField()
        Returns:
        the executionLinesOutputField

      • setExecutionLinesOutputField

        public void setExecutionLinesOutputField​(String executionLinesOutputField)
        Parameters:
        executionLinesOutputField - the executionLinesOutputField to set

      • getExecutionLinesRejectedField

        public String getExecutionLinesRejectedField()
        Returns:
        the executionLinesRejectedField

      • setExecutionLinesRejectedField

        public void setExecutionLinesRejectedField​(String executionLinesRejectedField)
        Parameters:
        executionLinesRejectedField - the executionLinesRejectedField to set

      • getExecutionLinesUpdatedField

        public String getExecutionLinesUpdatedField()
        Returns:
        the executionLinesUpdatedField

      • setExecutionLinesUpdatedField

        public void setExecutionLinesUpdatedField​(String executionLinesUpdatedField)
        Parameters:
        executionLinesUpdatedField - the executionLinesUpdatedField to set

      • getExecutionLinesDeletedField

        public String getExecutionLinesDeletedField()
        Returns:
        the executionLinesDeletedField

      • setExecutionLinesDeletedField

        public void setExecutionLinesDeletedField​(String executionLinesDeletedField)
        Parameters:
        executionLinesDeletedField - the executionLinesDeletedField to set

      • getExecutionFilesRetrievedField

        public String getExecutionFilesRetrievedField()
        Returns:
        the executionFilesRetrievedField

      • setExecutionFilesRetrievedField

        public void setExecutionFilesRetrievedField​(String executionFilesRetrievedField)
        Parameters:
        executionFilesRetrievedField - the executionFilesRetrievedField to set

      • getExecutionExitStatusField

        public String getExecutionExitStatusField()
        Returns:
        the executionExitStatusField

      • setExecutionExitStatusField

        public void setExecutionExitStatusField​(String executionExitStatusField)
        Parameters:
        executionExitStatusField - the executionExitStatusField to set

      • getExecutionLogTextField

        public String getExecutionLogTextField()
        Returns:
        the executionLogTextField

      • setExecutionLogTextField

        public void setExecutionLogTextField​(String executionLogTextField)
        Parameters:
        executionLogTextField - the executionLogTextField to set

      • getExecutionLogChannelIdField

        public String getExecutionLogChannelIdField()
        Returns:
        the executionLogChannelIdField

      • setExecutionLogChannelIdField

        public void setExecutionLogChannelIdField​(String executionLogChannelIdField)
        Parameters:
        executionLogChannelIdField - the executionLogChannelIdField to set

      • getGroupSize

        public String getGroupSize()
        Returns:
        the groupSize

      • setGroupSize

        public void setGroupSize​(String groupSize)
        Parameters:
        groupSize - the groupSize to set

      • getGroupField

        public String getGroupField()
        Returns:
        the groupField

      • setGroupField

        public void setGroupField​(String groupField)
        Parameters:
        groupField - the groupField to set

      • getGroupTime

        public String getGroupTime()
        Returns:
        the groupTime

      • setGroupTime

        public void setGroupTime​(String groupTime)
        Parameters:
        groupTime - the groupTime to set

      • excludeFromCopyDistributeVerification

        public boolean excludeFromCopyDistributeVerification()
        Specified by:
        excludeFromCopyDistributeVerification in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        excludeFromCopyDistributeVerification in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • getExecutionResultTargetTransform

        public String getExecutionResultTargetTransform()
        Returns:
        the executionResultTargetTransform

      • setExecutionResultTargetTransform

        public void setExecutionResultTargetTransform​(String executionResultTargetTransform)
        Parameters:
        executionResultTargetTransform - the executionResultTargetTransform to set

      • getExecutionResultTargetTransformMeta

        public org.apache.hop.pipeline.transform.TransformMeta getExecutionResultTargetTransformMeta()
        Returns:
        the executionResultTargetTransformMeta

      • setExecutionResultTargetTransformMeta

        public void setExecutionResultTargetTransformMeta​(org.apache.hop.pipeline.transform.TransformMeta executionResultTargetTransformMeta)
        Parameters:
        executionResultTargetTransformMeta - the executionResultTargetTransformMeta to set

      • getResultFilesFileNameField

        public String getResultFilesFileNameField()
        Returns:
        the resultFilesFileNameField

      • setResultFilesFileNameField

        public void setResultFilesFileNameField​(String resultFilesFileNameField)
        Parameters:
        resultFilesFileNameField - the resultFilesFileNameField to set

      • getReferencedObjectDescriptions

        public String[] getReferencedObjectDescriptions()
        Specified by:
        getReferencedObjectDescriptions in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        getReferencedObjectDescriptions in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>
        Returns:
        The objects referenced in the transform, like a mapping, a pipeline, ...

      • isReferencedObjectEnabled

        public boolean[] isReferencedObjectEnabled()
        Specified by:
        isReferencedObjectEnabled in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        isReferencedObjectEnabled in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>

      • loadReferencedObject

        public org.apache.hop.core.file.IHasFilename loadReferencedObject​(int index,
                                                                  IHopMetadataProvider metadataProvider,
                                                                  IVariables variables)
                                                           throws HopException
        Load the referenced object
        Specified by:
        loadReferencedObject in interface org.apache.hop.pipeline.transform.ITransformMeta
        Overrides:
        loadReferencedObject in class org.apache.hop.pipeline.transform.BaseTransformMeta<PipelineExecutor,​PipelineExecutorData>
        Parameters:
        index - the object index to load
        variables - the variable variables to use
        Returns:
        the referenced object once loaded
        Throws:
        HopException

      • getOutputRowsSourceTransform

        public String getOutputRowsSourceTransform()

      • setOutputRowsSourceTransform

        public void setOutputRowsSourceTransform​(String outputRowsSourceTransform)

      • getOutputRowsSourceTransformMeta

        public org.apache.hop.pipeline.transform.TransformMeta getOutputRowsSourceTransformMeta()

      • setOutputRowsSourceTransformMeta

        public void setOutputRowsSourceTransformMeta​(org.apache.hop.pipeline.transform.TransformMeta outputRowsSourceTransformMeta)

      • getOutputRowsField

        public String[] getOutputRowsField()

      • setOutputRowsField

        public void setOutputRowsField​(String[] outputRowsField)

      • getOutputRowsType

        public int[] getOutputRowsType()

      • setOutputRowsType

        public void setOutputRowsType​(int[] outputRowsType)

      • getOutputRowsLength

        public int[] getOutputRowsLength()

      • setOutputRowsLength

        public void setOutputRowsLength​(int[] outputRowsLength)

      • getOutputRowsPrecision

        public int[] getOutputRowsPrecision()

      • setOutputRowsPrecision

        public void setOutputRowsPrecision​(int[] outputRowsPrecision)

      • getResultFilesTargetTransform

        public String getResultFilesTargetTransform()

      • setResultFilesTargetTransform

        public void setResultFilesTargetTransform​(String resultFilesTargetTransform)

      • getResultFilesTargetTransformMeta

        public org.apache.hop.pipeline.transform.TransformMeta getResultFilesTargetTransformMeta()

      • setResultFilesTargetTransformMeta

        public void setResultFilesTargetTransformMeta​(org.apache.hop.pipeline.transform.TransformMeta resultFilesTargetTransformMeta)

      • getExecutorsOutputTransform

        public String getExecutorsOutputTransform()

      • setExecutorsOutputTransform

        public void setExecutorsOutputTransform​(String executorsOutputTransform)

      • getExecutorsOutputTransformMeta

        public org.apache.hop.pipeline.transform.TransformMeta getExecutorsOutputTransformMeta()

      • setExecutorsOutputTransformMeta

        public void setExecutorsOutputTransformMeta​(org.apache.hop.pipeline.transform.TransformMeta executorsOutputTransformMeta)

      • cleanAfterHopFromRemove

        public boolean cleanAfterHopFromRemove()
        Specified by:
        cleanAfterHopFromRemove in interface org.apache.hop.pipeline.transform.ITransformMeta

      • cleanAfterHopFromRemove

        public boolean cleanAfterHopFromRemove​(org.apache.hop.pipeline.transform.TransformMeta toTransform)
        Specified by:
        cleanAfterHopFromRemove in interface org.apache.hop.pipeline.transform.ITransformMeta

      • getRunConfigurationName

        public String getRunConfigurationName()
        Gets runConfigurationName
        Returns:
        value of runConfigurationName

      • setRunConfigurationName

        public void setRunConfigurationName​(String runConfigurationName)
        Parameters:
        runConfigurationName - The runConfigurationName to set

      • isFilenameInField

        public boolean isFilenameInField()

      • setFilenameInField

        public void setFilenameInField​(boolean filenameInField)

      • getFilenameField

        public String getFilenameField()

      • setFilenameField

        public void setFilenameField​(String filenameField)