Package org.pentaho.di.trans.steps.xbaseinput

Class XBaseInputMeta

    • Constructor Detail

      • XBaseInputMeta

        public XBaseInputMeta()

    • Method Detail

      • getDbfFileName

        public String getDbfFileName()
        Returns:
        Returns the dbfFileName.

      • setDbfFileName

        public void setDbfFileName​(String dbfFileName)
        Parameters:
        dbfFileName - The dbfFileName to set.

      • getRowLimit

        public int getRowLimit()
        Returns:
        Returns the rowLimit.

      • setRowLimit

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

      • getRowNrField

        public String getRowNrField()
        Returns:
        Returns the rowNrField.

      • setRowNrField

        public void setRowNrField​(String rowNrField)
        Parameters:
        rowNrField - The rowNrField to set.

      • isRowNrAdded

        public boolean isRowNrAdded()
        Returns:
        Returns the rowNrAdded.

      • setRowNrAdded

        public void setRowNrAdded​(boolean rowNrAdded)
        Parameters:
        rowNrAdded - The rowNrAdded to set.

      • getAcceptingField

        public String getAcceptingField()
        Returns:
        Returns the acceptingField.

      • setAcceptingField

        public void setAcceptingField​(String acceptingField)
        Parameters:
        acceptingField - The acceptingField to set.

      • isAcceptingFilenames

        public boolean isAcceptingFilenames()
        Returns:
        Returns the acceptingFilenames.

      • setAcceptingFilenames

        public void setAcceptingFilenames​(boolean acceptingFilenames)
        Parameters:
        acceptingFilenames - The acceptingFilenames to set.

      • getAcceptingStep

        public StepMeta getAcceptingStep()
        Returns:
        Returns the acceptingStep.

      • setAcceptingStep

        public void setAcceptingStep​(StepMeta acceptingStep)
        Parameters:
        acceptingStep - The acceptingStep to set.

      • getAcceptingStepName

        public String getAcceptingStepName()
        Returns:
        Returns the acceptingStepName.

      • setAcceptingStepName

        public void setAcceptingStepName​(String acceptingStepName)
        Parameters:
        acceptingStepName - The acceptingStepName to set.

      • getFilenameField

        public String getFilenameField()
        Returns:
        Returns the filenameField.

      • setFilenameField

        public void setFilenameField​(String filenameField)
        Parameters:
        filenameField - The filenameField to set.

      • includeFilename

        public boolean includeFilename()
        Returns:
        Returns the includeFilename.

      • setIncludeFilename

        public void setIncludeFilename​(boolean includeFilename)
        Parameters:
        includeFilename - The includeFilename 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.)

      • getLookupStepname

        public String getLookupStepname()

      • getInfoSteps

        public String[] getInfoSteps()

      • getOutputFields

        public org.pentaho.di.core.row.RowMetaInterface getOutputFields​(org.pentaho.di.core.fileinput.FileInputList files,
                                                                String name)
                                                         throws org.pentaho.di.core.exception.KettleStepException
        Throws:
        org.pentaho.di.core.exception.KettleStepException

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

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

      • getFilePaths

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

      • getTextFileList

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

      • getCharactersetName

        public String getCharactersetName()
        Returns:
        the charactersetName

      • setCharactersetName

        public void setCharactersetName​(String charactersetName)
        Parameters:
        charactersetName - the charactersetName to set

      • 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