Package org.apache.hop.workflow.actions.eval

Class ActionEval

  • All Implemented Interfaces:
    Cloneable, IAttributes, ICheckResultSource, IExtensionData, IHasLogChannel, ILoggingObject, IVariables, org.apache.hop.resource.IResourceHolder, org.apache.hop.workflow.action.IAction
    @Action(id="EVAL",
        name="i18n::ActionEval.Name",
        description="i18n::ActionEval.Description",
        image="eval.svg",
        categoryDescription="i18n:org.apache.hop.workflow:ActionCategory.Category.Scripting",
        keywords="i18n::ActionEval.keyword",
        documentationUrl="/workflow/actions/eval.html")
public class ActionEval
extends org.apache.hop.workflow.action.ActionBase
implements Cloneable, org.apache.hop.workflow.action.IAction
    Action type to evaluate the result of a previous action. It uses a piece of javascript to do this.

    • Field Summary

      • Fields inherited from class org.apache.hop.workflow.action.ActionBase

        attributesMap, containerObjectId, entryTransformSetVariablesMap, extensionDataMap, log, parentWorkflow, parentWorkflowMeta

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void check​(List<ICheckResult> remarks, org.apache.hop.workflow.WorkflowMeta workflowMeta, IVariables variables, IHopMetadataProvider metadataProvider)  
      Object clone()  
      boolean evaluate​(Result result, org.apache.hop.workflow.engine.IWorkflowEngine<org.apache.hop.workflow.WorkflowMeta> parentWorkflow, Result prevResult)
      Evaluate the result of the execution of previous action.
      Result execute​(Result prevResult, int nr)
      Execute this action and return the result.
      String getScript()  
      boolean isEvaluation()  
      boolean isUnconditional()  
      boolean resetErrorsBeforeExecution()  
      void setScript​(String s)  

      • Methods inherited from class org.apache.hop.workflow.action.ActionBase

        clear, copyFrom, equals, exportResources, getAttribute, getAttributes, getAttributesMap, getContainerId, getDescription, getDialogClassName, getEntryTransformSetVariable, getEntryTransformSetVariablesMap, getExtensionDataMap, getFilename, getLogChannel, getLogChannelId, getLogLevel, getMetadataProvider, getName, getObjectCopy, getObjectName, getObjectType, getParent, getParentVariables, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getResourceDependencies, getSqlStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariableBoolean, getVariableNames, getVariables, getXml, hasChanged, hashCode, initializeFrom, isBasic, isDebug, isDetailed, isForcingSeparateLogging, isGatheringMetrics, isPipeline, isReferencedObjectEnabled, isRowlevel, isStart, isWorkflow, loadReferencedObject, loadXml, loadXml, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resolve, resolve, resolve, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryTransformSetVariable, setForcingSeparateLogging, setGatheringMetrics, setLogLevel, setMetadataProvider, setName, setParentVariables, setParentWorkflow, setParentWorkflowMeta, setPluginId, setVariable, setVariables, shareWith, toString

      • Methods inherited from interface org.apache.hop.workflow.action.IAction

        clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSqlStatements, getXml, hasChanged, isPipeline, isReferencedObjectEnabled, isStart, isWorkflow, loadReferencedObject, loadXml, setChanged, setChanged, setDescription, setMetadataProvider, setName, setParentWorkflow, setParentWorkflowMeta, setPluginId

    • Constructor Detail

      • ActionEval

        public ActionEval()

      • ActionEval

        public ActionEval​(ActionEval other)

    • Method Detail

      • clone

        public Object clone()
        Specified by:
        clone in interface org.apache.hop.workflow.action.IAction
        Overrides:
        clone in class org.apache.hop.workflow.action.ActionBase

      • setScript

        public void setScript​(String s)

      • getScript

        public String getScript()

      • evaluate

        public boolean evaluate​(Result result,
                        org.apache.hop.workflow.engine.IWorkflowEngine<org.apache.hop.workflow.WorkflowMeta> parentWorkflow,
                        Result prevResult)
        Evaluate the result of the execution of previous action.
        Parameters:
        result - The result to evaulate.
        prevResult - the previous result
        parentWorkflow - the parent workflow
        Returns:
        The boolean result of the evaluation script.

      • execute

        public Result execute​(Result prevResult,
                      int nr)
        Execute this action and return the result. In this case it means, just set the result boolean in the Result class.
        Specified by:
        execute in interface org.apache.hop.workflow.action.IAction
        Parameters:
        prevResult - The result of the previous execution
        Returns:
        The Result of the execution.

      • resetErrorsBeforeExecution

        public boolean resetErrorsBeforeExecution()
        Specified by:
        resetErrorsBeforeExecution in interface org.apache.hop.workflow.action.IAction
        Overrides:
        resetErrorsBeforeExecution in class org.apache.hop.workflow.action.ActionBase

      • isEvaluation

        public boolean isEvaluation()
        Specified by:
        isEvaluation in interface org.apache.hop.workflow.action.IAction
        Overrides:
        isEvaluation in class org.apache.hop.workflow.action.ActionBase

      • isUnconditional

        public boolean isUnconditional()
        Specified by:
        isUnconditional in interface org.apache.hop.workflow.action.IAction
        Overrides:
        isUnconditional in class org.apache.hop.workflow.action.ActionBase

      • check

        public void check​(List<ICheckResult> remarks,
                  org.apache.hop.workflow.WorkflowMeta workflowMeta,
                  IVariables variables,
                  IHopMetadataProvider metadataProvider)
        Specified by:
        check in interface org.apache.hop.workflow.action.IAction
        Overrides:
        check in class org.apache.hop.workflow.action.ActionBase