Package org.pentaho.di.trans.steps.getfilesrowscount

Class GetFilesRowsCountMeta

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

  • Field Details

    • RequiredFilesDesc

      public static final String[] RequiredFilesDesc

    • RequiredFilesCode

      public static final String[] RequiredFilesCode

    • DEFAULT_ROWSCOUNT_FIELDNAME

      public static final String DEFAULT_ROWSCOUNT_FIELDNAME
      See Also:

  • Constructor Details

    • GetFilesRowsCountMeta

      public GetFilesRowsCountMeta()

  • Method Details

    • getRowSeparator

      public String getRowSeparator()
      Returns:
      Returns the row separator.

    • setRowSeparator

      public void setRowSeparator(String RowSeparatorin)
      Parameters:
      RowSeparatorin - The RowSeparator to set.

    • getRowSeparatorFormat

      public String getRowSeparatorFormat()
      Returns:
      Returns the row separator format.

    • setAddResultFile

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

    • setSmartCount

      public void setSmartCount(boolean smartCount)
      Parameters:
      smartCount - The smartCount to set.

    • getExludeFileMask

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

    • getExcludeFileMask

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

    • setExcludeFileMask

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

    • isAddResultFile

      public boolean isAddResultFile()
      Returns:
      Returns isaddresult.

    • isSmartCount

      public boolean isSmartCount()
      Returns:
      Returns smartCount.

    • setOutputFilenameField

      @Deprecated public String setOutputFilenameField()
      Deprecated.
      Returns:
      Returns the output filename_Field. Deprecated due to typo

    • getOutputFilenameField

      public String getOutputFilenameField()
      Returns:
      Returns the output filename_Field.

    • setOutputFilenameField

      public void setOutputFilenameField(String outputFilenameField)
      Parameters:
      outputFilenameField - The output filename_field to set.

    • isFileField

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

    • setFileField

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

    • setRowSeparatorFormat

      public void setRowSeparatorFormat(String RowSeparator_formatin)
      Parameters:
      RowSeparator_formatin - The RowSeparator_format to set.

    • getFileMask

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

    • setFileRequired

      public void setFileRequired(String[] fileRequiredin)

    • getIncludeSubFolders

      public String[] getIncludeSubFolders()

    • setIncludeSubFolders

      public void setIncludeSubFolders(String[] includeSubFoldersin)

    • getRequiredFilesCode

      public String getRequiredFilesCode(String tt)

    • getRequiredFilesDesc

      public String getRequiredFilesDesc(String tt)

    • setFileMask

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

    • getFileName

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

    • setFileName

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

    • includeCountFiles

      public boolean includeCountFiles()
      Returns:
      Returns the includeCountFiles.

    • setIncludeCountFiles

      public void setIncludeCountFiles(boolean includeFilesCount)
      Parameters:
      includeFilesCount - The "includes files count" flag to set.

    • getFileRequired

      public String[] getFileRequired()

    • getFilesCountFieldName

      public String getFilesCountFieldName()
      Returns:
      Returns the FilesCountFieldName.

    • getRowsCountFieldName

      public String getRowsCountFieldName()
      Returns:
      Returns the RowsCountFieldName.

    • setFilesCountFieldName

      public void setFilesCountFieldName(String filesCountFieldName)
      Parameters:
      filesCountFieldName - The filesCountFieldName to set.

    • setRowsCountFieldName

      public void setRowsCountFieldName(String rowsCountFieldName)
      Parameters:
      rowsCountFieldName - The rowsCountFieldName to set.

    • 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

    • 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.

    • 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 r, 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:
      r - 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

    • 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)

    • getFiles

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

    • 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

    • getStep

      public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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
      tr - 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
      Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. So what this does is turn the name of files into absolute paths OR it simply includes the resource in the ZIP file. For now, we'll simply turn it into an absolute path and pray that the file is on a shared drive or something like that.
      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