Package org.pentaho.di.trans.steps.csvinput

Class CsvInputMeta

    • Constructor Detail

      • CsvInputMeta

        public CsvInputMeta()

    • Method Detail

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

      • allocate

        public void allocate​(int nrFields)

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

      • getFields

        public void getFields​(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                      String origin,
                      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:
        rowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step
        origin - 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

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

      • setDelimiter

        public void setDelimiter​(String delimiter)
        Parameters:
        delimiter - the delimiter to set

      • getFilename

        public String getFilename()
        Returns:
        the filename

      • setFilename

        public void setFilename​(String filename)
        Parameters:
        filename - the filename to set

      • getBufferSize

        public String getBufferSize()
        Returns:
        the bufferSize

      • setBufferSize

        public void setBufferSize​(String bufferSize)
        Parameters:
        bufferSize - the bufferSize to set

      • isLazyConversionActive

        public boolean isLazyConversionActive()
        Returns:
        true if lazy conversion is turned on: conversions are delayed as long as possible, perhaps to never occur at all.

      • setLazyConversionActive

        public void setLazyConversionActive​(boolean lazyConversionActive)
        Parameters:
        lazyConversionActive - true if lazy conversion is to be turned on: conversions are delayed as long as possible, perhaps to never occur at all.

      • isHeaderPresent

        public boolean isHeaderPresent()
        Returns:
        the headerPresent

      • setHeaderPresent

        public void setHeaderPresent​(boolean headerPresent)
        Parameters:
        headerPresent - the headerPresent to set

      • setEnclosure

        public void setEnclosure​(String enclosure)
        Parameters:
        enclosure - the enclosure to set

      • setInputFields

        public void setInputFields​(TextFileInputField[] inputFields)
        Parameters:
        inputFields - the inputFields to set

      • getFilenameField

        public String getFilenameField()
        Returns:
        the filenameField

      • setFilenameField

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

      • isIncludingFilename

        public boolean isIncludingFilename()
        Returns:
        the includingFilename

      • setIncludingFilename

        public void setIncludingFilename​(boolean includingFilename)
        Parameters:
        includingFilename - the includingFilename to set

      • getRowNumField

        public String getRowNumField()
        Returns:
        the rowNumField

      • setRowNumField

        public void setRowNumField​(String rowNumField)
        Parameters:
        rowNumField - the rowNumField to set

      • setAddResultFile

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

      • isAddResultFile

        public boolean isAddResultFile()
        Returns:
        Returns isaddresult.

      • isRunningInParallel

        public boolean isRunningInParallel()
        Returns:
        the runningInParallel

      • setRunningInParallel

        public void setRunningInParallel​(boolean runningInParallel)
        Parameters:
        runningInParallel - the runningInParallel to set

      • getFileFormat

        public String getFileFormat()
        Returns:
        Returns the fileFormat

      • setFileFormat

        public void setFileFormat​(String fileFormat)
        Parameters:
        fileFormat - the fileFormat to set

      • setEncoding

        public void setEncoding​(String encoding)
        Parameters:
        encoding - the encoding 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
        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

      • getStepInjectionMetadataEntries

        public List<StepInjectionMetaEntry> getStepInjectionMetadataEntries()
                                                             throws org.pentaho.di.core.exception.KettleException
        Describe the metadata attributes that can be injected into this step metadata object.
        Specified by:
        getStepInjectionMetadataEntries in interface StepMetaInjectionInterface
        Returns:
        A list of step injection metadata entries. In case the data type of the entry is NONE (0) you will get at least one entry in the details section. You can use this list to see a description of all the metadata.
        Throws:
        org.pentaho.di.core.exception.KettleException

      • isNewlinePossibleInFields

        public boolean isNewlinePossibleInFields()
        Returns:
        the newlinePossibleInFields

      • setNewlinePossibleInFields

        public void setNewlinePossibleInFields​(boolean newlinePossibleInFields)
        Parameters:
        newlinePossibleInFields - the newlinePossibleInFields to set

      • getHeaderFileObject

        public org.apache.commons.vfs2.FileObject getHeaderFileObject​(TransMeta transMeta)
        Description copied from interface: CsvInputAwareMeta
        Returns a FileObject that corresponds to the first encountered input file. This object is used to read the file headers for the purpose of field parsing.
        Specified by:
        getHeaderFileObject in interface CsvInputAwareMeta
        Parameters:
        transMeta - the TransMeta
        Returns:
        null if the FileObject cannot be created.