Package org.pentaho.di.trans.steps.exceloutput

Class ExcelOutputMeta

    • Constructor Detail

      • ExcelOutputMeta

        public ExcelOutputMeta()

    • Method Detail

      • isCreateParentFolder

        public boolean isCreateParentFolder()
        Returns:
        Returns the createparentfolder.

      • setCreateParentFolder

        public void setCreateParentFolder​(boolean createparentfolder)
        Parameters:
        createparentfolder - The createparentfolder to set.

      • isDateInFilename

        public boolean isDateInFilename()
        Returns:
        Returns the dateInFilename.

      • setDateInFilename

        public void setDateInFilename​(boolean dateInFilename)
        Parameters:
        dateInFilename - The dateInFilename to set.

      • getExtension

        public String getExtension()
        Returns:
        Returns the extension.

      • setExtension

        public void setExtension​(String extension)
        Parameters:
        extension - The extension to set.

      • getFileName

        public String getFileName()
        Returns:
        Returns the fileName.

      • getPassword

        public String getPassword()
        Returns:
        Returns the password.

      • getSheetname

        public String getSheetname()
        Returns:
        Returns the sheet name.

      • setSheetname

        public void setSheetname​(String sheetname)
        Parameters:
        sheetname - The sheet name.

      • setFileName

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

      • setPassword

        public void setPassword​(String password)
        Parameters:
        password - teh passwoed to set.

      • isFooterEnabled

        public boolean isFooterEnabled()
        Returns:
        Returns the footer.

      • setFooterEnabled

        public void setFooterEnabled​(boolean footer)
        Parameters:
        footer - The footer to set.

      • isAutoSizeColumns

        public boolean isAutoSizeColumns()
        Returns:
        Returns the autosizecolumns.

      • setAutoSizeColumns

        public void setAutoSizeColumns​(boolean autosizecolumns)
        Parameters:
        autosizecolumns - The autosizecolumns to set.

      • isAutoSizeColums

        @Deprecated
public boolean isAutoSizeColums()
        Deprecated.
        due to typo
        Returns:
        Returns the autosizecolums.

      • setAutoSizeColums

        @Deprecated
public void setAutoSizeColums​(boolean autosizecolums)
        Deprecated.
        due to typo
        Parameters:
        autosizecolums - The autosizecolums to set.

      • setTempDirectory

        public void setTempDirectory​(String directory)

      • getTempDirectory

        public String getTempDirectory()

      • isNullBlank

        public boolean isNullBlank()
        Returns:
        Returns whether or not null values are written as blank cells.

      • setNullIsBlank

        public void setNullIsBlank​(boolean nullIsBlank)
        Parameters:
        nullIsBlank - The boolean indicating whether or not to write null values as blank cells

      • isHeaderEnabled

        public boolean isHeaderEnabled()
        Returns:
        Returns the header.

      • setHeaderEnabled

        public void setHeaderEnabled​(boolean header)
        Parameters:
        header - The header to set.

      • isSpecifyFormat

        public boolean isSpecifyFormat()

      • setSpecifyFormat

        public void setSpecifyFormat​(boolean SpecifyFormat)

      • getDateTimeFormat

        public String getDateTimeFormat()

      • setDateTimeFormat

        public void setDateTimeFormat​(String date_time_format)

      • getNewline

        public String getNewline()
        Returns:
        Returns the newline.

      • setNewline

        public void setNewline​(String newline)
        Parameters:
        newline - The newline to set.

      • getSplitEvery

        public int getSplitEvery()
        Returns:
        Returns the splitEvery.

      • isAddToResultFiles

        public boolean isAddToResultFiles()
        Returns:
        Returns the add to result filesname.

      • setAddToResultFiles

        public void setAddToResultFiles​(boolean addtoresultfilenamesin)
        Parameters:
        addtoresultfilenamesin - The addtoresultfilenames to set.

      • setSplitEvery

        public void setSplitEvery​(int splitEvery)
        Parameters:
        splitEvery - The splitEvery to set.

      • isStepNrInFilename

        public boolean isStepNrInFilename()
        Returns:
        Returns the stepNrInFilename.

      • setStepNrInFilename

        public void setStepNrInFilename​(boolean stepNrInFilename)
        Parameters:
        stepNrInFilename - The stepNrInFilename to set.

      • isTimeInFilename

        public boolean isTimeInFilename()
        Returns:
        Returns the timeInFilename.

      • isSheetProtected

        public boolean isSheetProtected()
        Returns:
        Returns the protectsheet.

      • setTimeInFilename

        public void setTimeInFilename​(boolean timeInFilename)
        Parameters:
        timeInFilename - The timeInFilename to set.

      • setProtectSheet

        public void setProtectSheet​(boolean protectsheet)
        Parameters:
        protectsheet - the value to set.

      • isUseTempFiles

        public boolean isUseTempFiles()
        Returns:
        Returns the usetempfile.

      • setUseTempFiles

        public void setUseTempFiles​(boolean usetempfiles)
        Parameters:
        usetempfiles - The usetempfiles to set.

      • getOutputFields

        public ExcelField[] getOutputFields()
        Returns:
        Returns the outputFields.

      • setOutputFields

        public void setOutputFields​(ExcelField[] outputFields)
        Parameters:
        outputFields - The outputFields to set.

      • getEncoding

        public String getEncoding()
        Returns:
        The desired encoding of output file, null or empty if the default system encoding needs to be used.

      • setEncoding

        public void setEncoding​(String encoding)
        Parameters:
        encoding - The desired encoding of output file, null or empty if the default system encoding needs to be used.

      • isTemplateEnabled

        public boolean isTemplateEnabled()
        Returns:
        Returns the template.

      • setTemplateEnabled

        public void setTemplateEnabled​(boolean template)
        Parameters:
        template - The template to set.

      • isTemplateAppend

        public boolean isTemplateAppend()
        Returns:
        Returns the templateAppend.

      • setTemplateAppend

        public void setTemplateAppend​(boolean templateAppend)
        Parameters:
        templateAppend - The templateAppend to set.

      • getTemplateFileName

        public String getTemplateFileName()
        Returns:
        Returns the templateFileName.

      • setTemplateFileName

        public void setTemplateFileName​(String templateFileName)
        Parameters:
        templateFileName - The templateFileName to set.

      • isDoNotOpenNewFileInit

        public boolean isDoNotOpenNewFileInit()
        Returns:
        Returns the "do not open new file at init" flag.

      • setDoNotOpenNewFileInit

        public void setDoNotOpenNewFileInit​(boolean doNotOpenNewFileInit)
        Parameters:
        doNotOpenNewFileInit - The "do not open new file at init" flag to set.

      • isAppend

        public boolean isAppend()
        Returns:
        Returns the append.

      • setAppend

        public void setAppend​(boolean append)
        Parameters:
        append - The append 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)

      • getFiles

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

      • buildFilename

        public String buildFilename​(org.pentaho.di.core.variables.VariableSpace space,
                            int stepnr,
                            int splitnr)

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

      • 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

      • 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

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

      • getFontNameDesc

        public static String getFontNameDesc​(int i)

      • getFontUnderlineDesc

        public static String getFontUnderlineDesc​(int i)

      • getFontOrientationDesc

        public static String getFontOrientationDesc​(int i)

      • getFontColorDesc

        public static String getFontColorDesc​(int i)

      • getFontAlignmentDesc

        public static String getFontAlignmentDesc​(int i)

      • getHeaderFontName

        public int getHeaderFontName()

      • getRowFontName

        public int getRowFontName()

      • getHeaderFontUnderline

        public int getHeaderFontUnderline()

      • getHeaderFontOrientation

        public int getHeaderFontOrientation()

      • getHeaderAlignment

        public int getHeaderAlignment()

      • getHeaderFontColor

        public int getHeaderFontColor()

      • getRowFontColor

        public int getRowFontColor()

      • getHeaderBackGroundColor

        public int getHeaderBackGroundColor()

      • getRowBackGroundColor

        public int getRowBackGroundColor()

      • getFontNameByDesc

        public static int getFontNameByDesc​(String tt)

      • getFontUnderlineByDesc

        public static int getFontUnderlineByDesc​(String tt)

      • getFontOrientationByDesc

        public static int getFontOrientationByDesc​(String tt)

      • getFontColorByDesc

        public static int getFontColorByDesc​(String tt)

      • getFontAlignmentByDesc

        public static int getFontAlignmentByDesc​(String tt)

      • setHeaderFontName

        public void setHeaderFontName​(int fontname)

      • setHeaderFontName

        public void setHeaderFontName​(String fontname)

      • setRowFontName

        public void setRowFontName​(int fontname)

      • setRowFontName

        public void setRowFontName​(String fontname)

      • setHeaderFontUnderline

        public void setHeaderFontUnderline​(int fontunderline)

      • setHeaderFontUnderline

        public void setHeaderFontUnderline​(String fontunderline)

      • setHeaderFontOrientation

        public void setHeaderFontOrientation​(int fontorientation)

      • setHeaderFontOrientation

        public void setHeaderFontOrientation​(String fontorientation)

      • setHeaderFontColor

        public void setHeaderFontColor​(int fontcolor)

      • setRowFontColor

        public void setRowFontColor​(int fontcolor)

      • setHeaderBackGroundColor

        public void setHeaderBackGroundColor​(int fontcolor)

      • setRowBackGroundColor

        public void setRowBackGroundColor​(int fontcolor)

      • setHeaderAlignment

        public void setHeaderAlignment​(int alignment)

      • setHeaderAlignment

        public void setHeaderAlignment​(String alignment)

      • setHeaderFontSize

        public void setHeaderFontSize​(String fontsize)

      • setRowFontSize

        public void setRowFontSize​(String fontsize)

      • getHeaderFontSize

        public String getHeaderFontSize()

      • getRowFontSize

        public String getRowFontSize()

      • setHeaderImage

        public void setHeaderImage​(String image)

      • getHeaderImage

        public String getHeaderImage()

      • setHeaderRowHeight

        public void setHeaderRowHeight​(String height)

      • getHeaderRowHeight

        public String getHeaderRowHeight()

      • isHeaderFontBold

        public boolean isHeaderFontBold()

      • setHeaderFontItalic

        public void setHeaderFontItalic​(boolean fontitalic)

      • isHeaderFontItalic

        public boolean isHeaderFontItalic()

      • setHeaderFontBold

        public void setHeaderFontBold​(boolean font_bold)