Package org.pentaho.di.trans.steps.sort

Class SortRowsMeta

    • Constructor Detail

      • SortRowsMeta

        public SortRowsMeta()

    • Method Detail

      • getAscending

        public boolean[] getAscending()
        Returns:
        Returns the ascending.

      • setAscending

        public void setAscending​(boolean[] ascending)
        Parameters:
        ascending - The ascending to set.

      • getDirectory

        public String getDirectory()
        Returns:
        Returns the directory.

      • setDirectory

        public void setDirectory​(String directory)
        Parameters:
        directory - The directory to set.

      • getFieldName

        public String[] getFieldName()
        Returns:
        Returns the fieldName.

      • setFieldName

        public void setFieldName​(String[] fieldName)
        Parameters:
        fieldName - The fieldName to set.

      • getPrefix

        public String getPrefix()
        Returns:
        Returns the prefix.

      • setPrefix

        public void setPrefix​(String prefix)
        Parameters:
        prefix - The prefix 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.)

      • allocate

        public void allocate​(int nrfields)

      • registerUrlWithDirectory

        protected void registerUrlWithDirectory()

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

      • assignSortingCriteria

        public void assignSortingCriteria​(org.pentaho.di.core.row.RowMetaInterface inputRowMeta)

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

      • getSortSize

        public String getSortSize()
        Returns:
        Returns the sortSize.

      • setSortSize

        public void setSortSize​(String sortSize)
        Parameters:
        sortSize - The sortSize to set.

      • getCompressFiles

        public boolean getCompressFiles()
        Returns:
        Returns whether temporary files should be compressed

      • setCompressFiles

        public void setCompressFiles​(boolean compressFiles)
        Parameters:
        compressFiles - Whether to compress temporary files created during sorting

      • isOnlyPassingUniqueRows

        public boolean isOnlyPassingUniqueRows()
        Returns:
        the onlyPassingUniqueRows

      • setOnlyPassingUniqueRows

        public void setOnlyPassingUniqueRows​(boolean onlyPassingUniqueRows)
        Parameters:
        onlyPassingUniqueRows - the onlyPassingUniqueRows to set

      • getCompressFilesVariable

        public String getCompressFilesVariable()
        Returns:
        the compressFilesVariable

      • setCompressFilesVariable

        public void setCompressFilesVariable​(String compressFilesVariable)
        Parameters:
        compressFilesVariable - the compressFilesVariable to set

      • getCaseSensitive

        public boolean[] getCaseSensitive()
        Returns:
        the caseSensitive

      • setCaseSensitive

        public void setCaseSensitive​(boolean[] caseSensitive)
        Parameters:
        caseSensitive - the caseSensitive to set

      • getCollatorEnabled

        public boolean[] getCollatorEnabled()
        Returns:
        the collatorEnabled

      • setCollatorEnabled

        public void setCollatorEnabled​(boolean[] collatorEnabled)
        Parameters:
        collatorEnabled - the collatorEnabled to set

      • getCollatorStrength

        public int[] getCollatorStrength()
        Returns:
        the collatorStrength

      • setCollatorStrength

        public void setCollatorStrength​(int[] collatorStrength)
        Parameters:
        collatorStrength - the collatorStrength to set

      • getFreeMemoryLimit

        public String getFreeMemoryLimit()
        Returns:
        the freeMemoryLimit

      • setFreeMemoryLimit

        public void setFreeMemoryLimit​(String freeMemoryLimit)
        Parameters:
        freeMemoryLimit - the freeMemoryLimit to set

      • getPreSortedField

        public boolean[] getPreSortedField()
        Returns:
        the preSortedField

      • setPreSortedField

        public void setPreSortedField​(boolean[] preSorted)
        Parameters:
        preSorted - the preSorteField to set

      • getGroupFields

        public List<String> getGroupFields()

      • isGroupSortEnabled

        public boolean isGroupSortEnabled()

      • afterInjectionSynchronization

        public void afterInjectionSynchronization()
        If we use injection we can have different arrays lengths. We need synchronize them for consistency behavior with UI