Package org.pentaho.di.trans.steps.excelwriter

Class ExcelWriterStep

  • All Implemented Interfaces:
    org.pentaho.di.core.ExtensionDataInterface, HasLogChannelInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, StepInterface
    public class ExcelWriterStep
extends BaseStep
implements StepInterface

    • Method Detail

      • processRow

        public boolean processRow​(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepInterface
        Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).
        Specified by:
        processRow in interface StepInterface
        Overrides:
        processRow in class BaseStep
        Parameters:
        smi - The steps metadata to work with
        sdi - The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)
        Returns:
        false if no more rows can be processed or an error occurred.
        Throws:
        org.pentaho.di.core.exception.KettleException

      • writeNextLine

        public void writeNextLine​(Object[] r)
                   throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • buildFilename

        public String buildFilename​(int splitNr)
        Returns the output filename that belongs to this step observing the file split feature
        Returns:
        current output filename to write to

      • copyFile

        public static void copyFile​(org.apache.commons.vfs2.FileObject in,
                            org.apache.commons.vfs2.FileObject out)
                     throws org.pentaho.di.core.exception.KettleException
        Copies a VFS File
        Parameters:
        in - the source file object
        out - the destination file object
        Throws:
        org.pentaho.di.core.exception.KettleException

      • prepareNextOutputFile

        public void prepareNextOutputFile()
                           throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • protectSheet

        protected void protectSheet​(org.apache.poi.ss.usermodel.Sheet sheet,
                            String password)
        Write protect Sheet by setting password works only for xls output at the moment