Class XRFFSaver

    • Constructor Detail

      • XRFFSaver

        public XRFFSaver()
        Constructor
    • Method Detail

      • globalInfo

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

        public java.util.Enumeration listOptions()
        Returns an enumeration describing the available options.
        Specified by:
        listOptions in interface OptionHandler
        Overrides:
        listOptions in class AbstractFileSaver
        Returns:
        an enumeration of all the available options.
      • setOptions

        public void setOptions​(java.lang.String[] options)
                        throws java.lang.Exception
        Parses the options for this object.

        Valid options are:

         -i <the input file>
          The input file
         -o <the output file>
          The output file
         -C <class index>
          The class index (first and last are valid as well).
          (default: last)
         -compress
          Compresses the data (uses '.xrff.gz' as extension instead of '.xrff')
          (default: off)
        Specified by:
        setOptions in interface OptionHandler
        Overrides:
        setOptions in class AbstractFileSaver
        Parameters:
        options - the options to use
        Throws:
        java.lang.Exception - if setting of options fails
      • setFile

        public void setFile​(java.io.File outputFile)
                     throws java.io.IOException
        Sets the destination file.
        Specified by:
        setFile in interface FileSourcedConverter
        Specified by:
        setFile in interface Saver
        Overrides:
        setFile in class AbstractFileSaver
        Parameters:
        outputFile - the destination file.
        Throws:
        java.io.IOException - throws an IOException if file cannot be set
      • classIndexTipText

        public java.lang.String classIndexTipText()
        Returns the tip text for this property
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui
      • getClassIndex

        public java.lang.String getClassIndex()
        Get the index of the class attribute.
        Returns:
        the index of the class attribute
      • setClassIndex

        public void setClassIndex​(java.lang.String value)
        Sets index of the class attribute.
        Parameters:
        value - the index of the class attribute
      • compressOutputTipText

        public java.lang.String compressOutputTipText()
        Returns the tip text for this property
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui
      • getCompressOutput

        public boolean getCompressOutput()
        Gets whether the output data is compressed.
        Returns:
        true if the output data is compressed
      • setCompressOutput

        public void setCompressOutput​(boolean value)
        Sets whether to compress the output.
        Parameters:
        value - if truee the output will be compressed
      • setDestination

        public void setDestination​(java.io.OutputStream output)
                            throws java.io.IOException
        Sets the destination output stream.
        Specified by:
        setDestination in interface Saver
        Overrides:
        setDestination in class AbstractFileSaver
        Parameters:
        output - the output stream.
        Throws:
        java.io.IOException - throws an IOException if destination cannot be set
      • writeBatch

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

        public java.lang.String getRevision()
        Returns the revision string.
        Specified by:
        getRevision in interface RevisionHandler
        Returns:
        the revision
      • main

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