Package org.pentaho.di.trans.steps.getfilenames

Class GetFileNamesMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.getfilenames.GetFileNamesMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface
public class GetFileNamesMeta extends BaseStepMeta implements StepMetaInterface

  • Field Details

    • RequiredFilesDesc

      public static final String[] RequiredFilesDesc

    • RequiredFilesCode

      public static final String[] RequiredFilesCode

  • Constructor Details

    • GetFileNamesMeta

      public GetFileNamesMeta()

  • Method Details

    • isdoNotFailIfNoFile

      public boolean isdoNotFailIfNoFile()
      Returns:
      the doNotFailIfNoFile flag

    • setdoNotFailIfNoFile

      public void setdoNotFailIfNoFile(boolean doNotFailIfNoFile)
      Parameters:
      doNotFailIfNoFile - the doNotFailIfNoFile to set

    • getFilenameField

      public String getFilenameField()
      Returns:
      Returns the filenameField.

    • getRowNumberField

      public String getRowNumberField()
      Returns:
      Returns the rowNumberField.

    • setDynamicFilenameField

      public void setDynamicFilenameField(String dynamicFilenameField)
      Parameters:
      dynamicFilenameField - The dynamic filename field to set.

    • setDynamicWildcardField

      public void setDynamicWildcardField(String dynamicWildcardField)
      Parameters:
      dynamicWildcardField - The dynamic wildcard field to set.

    • setRowNumberField

      public void setRowNumberField(String rowNumberField)
      Parameters:
      rowNumberField - The rowNumberField to set.

    • getDynamicFilenameField

      public String getDynamicFilenameField()
      Returns:
      Returns the dynamic filename field (from previous steps)

    • getDynamicWildcardField

      public String getDynamicWildcardField()
      Returns:
      Returns the dynamic wildcard field (from previous steps)

    • getDynamicExcludeWildcardField

      public String getDynamicExcludeWildcardField()

    • setDynamicExcludeWildcardField

      public void setDynamicExcludeWildcardField(String dynamicExcludeWildcardField)
      Parameters:
      excludeWildcard - The dynamic excludeWildcard field to set.

    • includeRowNumber

      public boolean includeRowNumber()
      Returns:
      Returns the includeRowNumber.

    • isFileField

      public boolean isFileField()
      Returns:
      Returns the File field.

    • setFileField

      public void setFileField(boolean filefield)
      Parameters:
      filefield - The filefield to set.

    • isDynamicIncludeSubFolders

      public boolean isDynamicIncludeSubFolders()

    • setDynamicIncludeSubFolders

      public void setDynamicIncludeSubFolders(boolean dynamicIncludeSubFolders)

    • setIncludeRowNumber

      public void setIncludeRowNumber(boolean includeRowNumber)
      Parameters:
      includeRowNumber - The includeRowNumber to set.

    • setAddResultFile

      public void setAddResultFile(boolean isaddresult)
      Parameters:
      isaddresult - The isaddresult to set.

    • isAddResultFile

      public boolean isAddResultFile()
      Returns:
      Returns isaddresult.

    • getFileMask

      public String[] getFileMask()
      Returns:
      Returns the fileMask.

    • getFileRequired

      public String[] getFileRequired()
      Returns:
      Returns the fileRequired.

    • setFileMask

      public void setFileMask(String[] fileMask)
      Parameters:
      fileMask - The fileMask to set.

    • setExcludeFileMask

      public void setExcludeFileMask(String[] excludeFileMask)
      Parameters:
      excludeFileMask - The excludeFileMask to set.

    • getExludeFileMask

      @Deprecated public String[] getExludeFileMask()
      Deprecated.
      Returns:
      Returns the excludeFileMask. Deprecated due to typo

    • getExcludeFileMask

      public String[] getExcludeFileMask()
      Returns:
      Returns the excludeFileMask.

    • setFileRequired

      public void setFileRequired(String[] fileRequiredin)
      Parameters:
      fileRequired - The fileRequired to set.

    • getFileName

      public String[] getFileName()
      Returns:
      Returns the fileName.

    • setFileName

      public void setFileName(String[] fileName)
      Parameters:
      fileName - The fileName to set.

    • getRequiredFilesDesc

      public String getRequiredFilesDesc(String tt)

    • setIncludeSubFolders

      public void setIncludeSubFolders(String[] includeSubFoldersin)

    • getRequiredFilesCode

      public String getRequiredFilesCode(String tt)

    • getRowLimit

      public long getRowLimit()
      Returns:
      Returns the rowLimit.

    • setRowLimit

      public void setRowLimit(long rowLimit)
      Parameters:
      rowLimit - The rowLimit to set.

    • setFilterFileType

      @Deprecated public void setFilterFileType(int filtertypevalue)
      Deprecated.

    • setFilterFileType

      public void setFilterFileType(org.pentaho.di.core.fileinput.FileInputList.FileTypeFilter filter)

    • getFileTypeFilter

      public org.pentaho.di.core.fileinput.FileInputList.FileTypeFilter getFileTypeFilter()

    • loadXML

      public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException
      Description copied from interface: StepMetaInterface
      Load the values for this step from an XML Node
      Specified by:
      loadXML in interface StepMetaInterface
      Overrides:
      loadXML in class BaseStepMeta
      Parameters:
      stepnode - the Node to get the info from
      databases - The available list of databases to reference to
      metaStore - the metastore to optionally load external reference metadata from
      Throws:
      org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

    • clone

      public Object clone()
      Description copied from interface: StepMetaInterface
      Make an exact copy of this step, make sure to explicitly copy Collections etc.
      Specified by:
      clone in interface StepMetaInterface
      Overrides:
      clone in class BaseStepMeta
      Returns:
      an exact copy of this step

    • allocate

      public void allocate(int nrfiles)

    • setDefault

      public void setDefault()
      Description copied from interface: StepMetaInterface
      Set default values
      Specified by:
      setDefault in interface StepMetaInterface

    • getFields

      public void getFields(org.pentaho.di.core.row.RowMetaInterface row, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException
      Description copied from class: BaseStepMeta
      Gets the fields.
      Specified by:
      getFields in interface StepMetaInterface
      Overrides:
      getFields in class BaseStepMeta
      Parameters:
      row - the input row meta that is modified in this method to reflect the output row metadata of the step
      name - Name of the step to use as input for the origin field in the values
      info - Fields used as extra lookup information
      nextStep - the next step that is targeted
      space - the space The variable space to use to replace variables
      repository - the repository to use to load Kettle metadata objects impacting the output fields
      metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
      Throws:
      org.pentaho.di.core.exception.KettleStepException - the kettle step exception

    • getXML

      public String getXML()
      Description copied from class: BaseStepMeta
      Produces the XML string that describes this step's information.
      Specified by:
      getXML in interface StepMetaInterface
      Overrides:
      getXML in class BaseStepMeta
      Returns:
      String containing the XML describing this step.

    • readRep

      public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Read the steps information from a Kettle repository
      Specified by:
      readRep in interface StepMetaInterface
      Overrides:
      readRep in class BaseStepMeta
      Parameters:
      rep - The repository to read from
      metaStore - The MetaStore to read external information from
      id_step - The step ID
      databases - The databases to reference
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • saveRep

      public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Save the steps data into a Kettle repository
      Specified by:
      saveRep in interface StepMetaInterface
      Overrides:
      saveRep in class BaseStepMeta
      Parameters:
      rep - The Kettle repository to save to
      metaStore - the metaStore to optionally write to
      id_transformation - The transformation ID
      id_step - The step ID
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • getIncludeSubFolders

      public String[] getIncludeSubFolders()

    • getFilePaths

      public String[] getFilePaths(org.pentaho.di.core.variables.VariableSpace space)

    • getFileList

      public org.pentaho.di.core.fileinput.FileInputList getFileList(org.pentaho.di.core.variables.VariableSpace space)

    • getDynamicFileList

      public org.pentaho.di.core.fileinput.FileInputList getDynamicFileList(org.pentaho.di.core.variables.VariableSpace space, String[] filename, String[] filemask, String[] excludefilemask, String[] filerequired, boolean[] includesubfolders)

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
      Description copied from interface: StepMetaInterface
      Checks the settings of this step and puts the findings in a remarks List.
      Specified by:
      check in interface StepMetaInterface
      Overrides:
      check in class BaseStepMeta
      Parameters:
      remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
      stepMeta - The stepMeta to help checking
      prev - The fields coming from the previous step
      input - The input step names
      output - The output step names
      info - The fields that are used as information by the step
      space - the variable space to resolve variable expressions with
      repository - the repository to use to load Kettle metadata objects impacting the output fields
      metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

    • getResourceDependencies

      public List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
      Description copied from class: BaseStepMeta
      Get a list of all the resource dependencies that the step is depending on.
      Specified by:
      getResourceDependencies in interface StepMetaInterface
      Overrides:
      getResourceDependencies in class BaseStepMeta
      Returns:
      a list of all the resource dependencies that the step is depending on

    • getStep

      public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
      Description copied from interface: StepMetaInterface
      Get the executing step, needed by Trans to launch a step.
      Specified by:
      getStep in interface StepMetaInterface
      Parameters:
      stepMeta - The step info
      stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
      cnr - The copy nr to get
      transMeta - The transformation info
      trans - The launching transformation

    • getStepData

      public StepDataInterface getStepData()
      Description copied from interface: StepMetaInterface
      Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.
      Specified by:
      getStepData in interface StepMetaInterface
      Returns:
      The appropriate StepDataInterface class.

    • exportResources

      public String exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleException
      Specified by:
      exportResources in interface StepMetaInterface
      Overrides:
      exportResources in class BaseStepMeta
      Parameters:
      space - the variable space to use
      definitions -
      resourceNamingInterface -
      repository - The repository to optionally load other resources from (to be converted to XML)
      metaStore - the metaStore in which non-kettle metadata could reside.
      Returns:
      the filename of the exported resource
      Throws:
      org.pentaho.di.core.exception.KettleException