Class Formula

    • Field Summary

      • Fields inherited from class org.apache.hop.pipeline.transform.BaseTransform

        data, deadLockCounter, executionEndDate, executionStartDate, extensionDataMap, first, firstRowReadDate, initStartDate, lastRowWrittenDate, log, meta, metadataProvider, rowListeners, safeStopped, terminator, terminatorRows, variables
    • Constructor Summary

      Constructors 
      Constructor Description
      Formula​(org.apache.hop.pipeline.transform.TransformMeta transformMeta, FormulaMeta meta, FormulaData data, int copyNr, org.apache.hop.pipeline.PipelineMeta pipelineMeta, org.apache.hop.pipeline.Pipeline pipeline)
      This is the base transform that forms that basis for all transforms.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void dispose()  
      protected Object getReturnValue​(Object formulaResult, int returnType, int realIndex, FormulaMetaFunction fn)  
      boolean init()  
      boolean processRow()  
      • Methods inherited from class org.apache.hop.pipeline.transform.BaseTransform

        addResultFile, addRowListener, addRowSetToInputRowSets, addRowSetToOutputRowSets, addTransformFinishedListener, addTransformStartedListener, batchComplete, canProcessOneRow, checkFeedback, cleanup, clearInputRowSets, clearOutputRowSets, closeQuietly, copyFrom, decrementLinesRead, decrementLinesWritten, dispatch, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, finishBundle, getContainerId, getCopy, getCopyNr, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getData, getDispatcher, getErrorRowMeta, getErrors, getExecutionDuration, getExecutionEndDate, getExecutionStartDate, getExtensionDataMap, getFilename, getFirstInputRowSet, getFirstRowReadDate, getInitStartDate, getInputBufferSize, getInputRowMeta, getInputRowSets, getLastRowWrittenDate, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesSkipped, getLinesUpdated, getLinesWritten, getLogChannel, getLogChannelId, getLogLevel, getLogText, getMeta, getMetadataProvider, getName, getObjectCopy, getObjectName, getObjectType, getOutputBufferSize, getOutputRowSets, getParent, getParentVariables, getPartitionId, getPartitionTargets, getPipeline, getPipelineMeta, getPreviewRowMeta, getProcessed, getRegistrationDate, getRepartitioning, getResultFiles, getRow, getRowFrom, getRowHandler, getRowListeners, getStatus, getStatusDescription, getTransformFinishedListeners, getTransformMeta, getTransformName, getTransformPluginId, getTransformStartedListeners, getVariable, getVariable, getVariableBoolean, getVariableNames, handleGetRowFrom, handlePutError, handlePutRowTo, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeFrom, isAllowEmptyFieldNamesAndTypes, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isSafeStopped, isSelected, isStopped, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resolve, resolve, resolve, resumeRunning, rowsetInputSize, rowsetOutputSize, safeModeChecking, safeModeChecking, setAllowEmptyFieldNamesAndTypes, setCarteObjectId, setCopy, setCopyNr, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setDistributed, setErrorRowMeta, setErrors, setExecutionEndDate, setExecutionStartDate, setFirstRowReadDate, setForcingSeparateLogging, setGatheringMetrics, setInitStartDate, setInputRowMeta, setInputRowSets, setInternalVariables, setLastRowWrittenDate, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setMetadataProvider, setOutputDone, setOutputRowSets, setParentVariables, setPartitioned, setPartitionId, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRowHandler, setRunning, setSafeStopped, setStopped, setTransformFinishedListeners, setTransformName, setTransformStartedListeners, setVariable, setVariables, shareWith, startBundle, stopAll, stopRunning, swapFirstInputRowSetIfExists, toString, waitUntilPipelineIsStarted
      • Methods inherited from interface org.apache.hop.pipeline.transform.ITransform

        subStatuses
    • Constructor Detail

      • Formula

        public Formula​(org.apache.hop.pipeline.transform.TransformMeta transformMeta,
                       FormulaMeta meta,
                       FormulaData data,
                       int copyNr,
                       org.apache.hop.pipeline.PipelineMeta pipelineMeta,
                       org.apache.hop.pipeline.Pipeline pipeline)
        This is the base transform that forms that basis for all transforms. You can derive from this class to implement your own transforms.
        Parameters:
        transformMeta - The TransformMeta object to run.
        meta -
        data - the data object to store temporary data, database connections, caches, result sets, hashtables etc.
        copyNr - The copynumber for this transform.
        pipelineMeta - The PipelineMeta of which the transform transformMeta is part of.
        pipeline - The (running) pipeline to obtain information shared among the transforms.
    • Method Detail

      • init

        public boolean init()
        Specified by:
        init in interface org.apache.hop.pipeline.transform.ITransform
        Overrides:
        init in class org.apache.hop.pipeline.transform.BaseTransform<FormulaMeta,​FormulaData>
      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.apache.hop.pipeline.transform.ITransform
        Overrides:
        dispose in class org.apache.hop.pipeline.transform.BaseTransform<FormulaMeta,​FormulaData>
      • processRow

        public boolean processRow()
                           throws HopException
        Specified by:
        processRow in interface org.apache.hop.pipeline.transform.ITransform
        Overrides:
        processRow in class org.apache.hop.pipeline.transform.BaseTransform<FormulaMeta,​FormulaData>
        Throws:
        HopException