Package weka.core.converters

Class ExcelSaver

  • All Implemented Interfaces:
    Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.converters.BatchConverter, weka.core.converters.FileSourcedConverter, weka.core.converters.Saver, weka.core.EnvironmentHandler, weka.core.OptionHandler, weka.core.RevisionHandler
    public class ExcelSaver
extends weka.core.converters.AbstractFileSaver
implements weka.core.converters.BatchConverter
    Saves Instances as MS Excel spreadsheet files.

    Valid options are: 

     -i <the input file>
  The input file
     -o <the output file>
  The output file
     -missing-value <string>
  The string to use for missing values).
  (default: blank)
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Saver, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_MissingValue
      The placeholder for missing values.
      protected File m_OutputFile
      the file to write to.

      • Fields inherited from class weka.core.converters.AbstractFileSaver

        m_env, m_incrementalCounter, m_useRelativePath

      • Fields inherited from class weka.core.converters.AbstractSaver

        CANCEL, m_DoNotCheckCapabilities, m_retrieval, STRUCTURE_READY, WAIT, WRITE

      • Fields inherited from interface weka.core.converters.Saver

        BATCH, INCREMENTAL, NONE

    • Constructor Summary

      Constructors 
      Constructor Description
      ExcelSaver()
      Constructor

    • Field Detail

      • m_MissingValue

        protected String m_MissingValue
        The placeholder for missing values.

      • m_OutputFile

        protected File m_OutputFile
        the file to write to.

    • Constructor Detail

      • ExcelSaver

        public ExcelSaver()
        Constructor

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing this Saver
        Returns:
        a description of the Saver suitable for displaying in the explorer/experimenter gui

      • listOptions

        public Enumeration listOptions()
        Returns an enumeration describing the available options.
        Specified by:
        listOptions in interface weka.core.OptionHandler
        Overrides:
        listOptions in class weka.core.converters.AbstractFileSaver
        Returns:
        an enumeration of all the available options.

      • setMissingValue

        public void setMissingValue​(String value)
        Sets the placeholder for missing values.
        Parameters:
        value - the placeholder

      • getMissingValue

        public String getMissingValue()
        Returns the current placeholder for missing values.
        Returns:
        the placeholder

      • missingValueTipText

        public String missingValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • resetOptions

        public void resetOptions()
        Overrides:
        resetOptions in class weka.core.converters.AbstractFileSaver

      • getOptions

        public String[] getOptions()
        returns the options of the current setup
        Specified by:
        getOptions in interface weka.core.OptionHandler
        Overrides:
        getOptions in class weka.core.converters.AbstractFileSaver
        Returns:
        the current options

      • setOptions

        public void setOptions​(String[] options)
                throws Exception
        Parses the options for this object.
        Specified by:
        setOptions in interface weka.core.OptionHandler
        Overrides:
        setOptions in class weka.core.converters.AbstractFileSaver
        Parameters:
        options - the options to use
        Throws:
        Exception - if setting of options fails

      • getFileDescription

        public String getFileDescription()
        Returns a description of the file type.
        Specified by:
        getFileDescription in interface weka.core.converters.FileSourcedConverter
        Specified by:
        getFileDescription in class weka.core.converters.AbstractFileSaver
        Returns:
        a short file description

      • getFileExtension

        public String getFileExtension()
        Get the file extension used for this type of file
        Specified by:
        getFileExtension in interface weka.core.converters.FileSourcedConverter
        Specified by:
        getFileExtension in interface weka.core.converters.Saver
        Overrides:
        getFileExtension in class weka.core.converters.AbstractFileSaver
        Returns:
        the file extension

      • getFileExtensions

        public String[] getFileExtensions()
        Gets all the file extensions used for this type of file
        Specified by:
        getFileExtensions in interface weka.core.converters.FileSourcedConverter
        Overrides:
        getFileExtensions in class weka.core.converters.AbstractFileSaver
        Returns:
        the file extensions

      • getCapabilities

        public weka.core.Capabilities getCapabilities()
        Returns the Capabilities of this saver.
        Specified by:
        getCapabilities in interface weka.core.CapabilitiesHandler
        Overrides:
        getCapabilities in class weka.core.converters.AbstractSaver
        Returns:
        the capabilities of this object
        See Also:
        Capabilities

      • setDestination

        public void setDestination​(File file)
                    throws IOException
        Sets the destination file (and directories if necessary).
        Specified by:
        setDestination in interface weka.core.converters.Saver
        Overrides:
        setDestination in class weka.core.converters.AbstractFileSaver
        Parameters:
        file - the File
        Throws:
        IOException - always

      • setDestination

        public void setDestination​(OutputStream output)
                    throws IOException
        Default implementation throws an IOException.
        Specified by:
        setDestination in interface weka.core.converters.Saver
        Overrides:
        setDestination in class weka.core.converters.AbstractFileSaver
        Parameters:
        output - the OutputStream
        Throws:
        IOException - always

      • writeData

        protected void writeData​(weka.core.Instances data,
                         org.apache.poi.ss.usermodel.Workbook workbook)
        Writes the data to the workbook.
        Parameters:
        data - the data to write
        workbook - the workbook to write to

      • writeBatch

        public void writeBatch()
                throws IOException
        Writes a Batch of instances
        Specified by:
        writeBatch in interface weka.core.converters.Saver
        Specified by:
        writeBatch in class weka.core.converters.AbstractSaver
        Throws:
        IOException - throws IOException if saving in batch mode is not possible

      • getRevision

        public String getRevision()
        Returns the revision string.
        Specified by:
        getRevision in interface weka.core.RevisionHandler
        Returns:
        the revision

      • main

        public static void main​(String[] args)
        Main method.
        Parameters:
        args - should contain the options of a Saver.