Package org.apache.hop.workflow.actions.createfolder

Class ActionCreateFolder

  • All Implemented Interfaces:
    Cloneable, IAttributes, ICheckResultSource, IExtensionData, IHasLogChannel, ILoggingObject, IVariables, org.apache.hop.resource.IResourceHolder, org.apache.hop.workflow.action.IAction
    @Action(id="CREATE_FOLDER",
        name="i18n::ActionCreateFolder.Name",
        description="i18n::ActionCreateFolder.Description",
        image="CreateFolder.svg",
        categoryDescription="i18n:org.apache.hop.workflow:ActionCategory.Category.FileManagement",
        keywords="i18n::ActionCreateFolder.keyword",
        documentationUrl="/workflow/actions/createfolder.html")
public class ActionCreateFolder
extends org.apache.hop.workflow.action.ActionBase
implements Cloneable, org.apache.hop.workflow.action.IAction
    This defines a 'create folder' action. Its main use would be to create empty folder that can be used to control the flow in ETL cycles.

    • 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)  
      ActionCreateFolder clone()  
      Result execute​(Result previousResult, int nr)  
      String getFolderName()
      Gets folderName
      String getRealFolderName()  
      boolean isEvaluation()  
      boolean isFailIfFolderExists()
      Gets failIfFolderExists
      void setFailIfFolderExists​(boolean failIfFolderExists)
      Sets failIfFolderExists
      void setFolderName​(String folderName)
      Sets folderName

      • 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, isUnconditional, isWorkflow, loadReferencedObject, loadXml, loadXml, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resetErrorsBeforeExecution, 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, isUnconditional, isWorkflow, loadReferencedObject, loadXml, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setMetadataProvider, setName, setParentWorkflow, setParentWorkflowMeta, setPluginId

    • Constructor Detail

      • ActionCreateFolder

        public ActionCreateFolder​(String n)

      • ActionCreateFolder

        public ActionCreateFolder()

    • Method Detail

      • clone

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

      • execute

        public Result execute​(Result previousResult,
                      int nr)
        Specified by:
        execute in interface org.apache.hop.workflow.action.IAction

      • 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

      • 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

      • getRealFolderName

        public String getRealFolderName()

      • getFolderName

        public String getFolderName()
        Gets folderName
        Returns:
        value of folderName

      • setFolderName

        public void setFolderName​(String folderName)
        Sets folderName
        Parameters:
        folderName - value of folderName

      • isFailIfFolderExists

        public boolean isFailIfFolderExists()
        Gets failIfFolderExists
        Returns:
        value of failIfFolderExists

      • setFailIfFolderExists

        public void setFailIfFolderExists​(boolean failIfFolderExists)
        Sets failIfFolderExists
        Parameters:
        failIfFolderExists - value of failIfFolderExists