Interface Saver

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BATCH  
      static int INCREMENTAL  
      static int NONE
      The retrieval modes
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String filePrefix()
      Gets the file prefix This method is used in the KnowledgeFlow GUI.
      java.lang.String getFileExtension()
      Gets the file extension
      int getWriteMode()
      Gets the write mode
      java.lang.String retrieveDir()
      Gets the driectory of the output file This method is used in the KnowledgeFlow GUI.
      void setDestination​(java.io.File file)
      Resets the Saver object and sets the destination to be the supplied File object.
      void setDestination​(java.io.OutputStream output)
      Resets the Saver object and sets the destination to be the supplied InputStream.
      void setDir​(java.lang.String dir)
      Sets the directory of the output file.
      void setDirAndPrefix​(java.lang.String relationName, java.lang.String add)
      Sets the file prefix and the directory.
      void setFile​(java.io.File file)
      Sets the output file
      void setFilePrefix​(java.lang.String prefix)
      Sets the file prefix.
      void setInstances​(Instances instances)
      Sets the instances to be saved
      void setRetrieval​(int mode)
      Sets the retrieval mode
      void writeBatch()
      Writes to a destination in batch mode
      void writeIncremental​(Instance inst)
      Writes to a destination in incremental mode.
    • Method Detail

      • setDestination

        void setDestination​(java.io.File file)
                     throws java.io.IOException
        Resets the Saver object and sets the destination to be the supplied File object.
        Parameters:
        file - the File
        Throws:
        java.io.IOException - if an error occurs support loading from a File.
        
            public_normal_behavior
              requires: file != null
                        && (* file exists *);
              modifiable: model_sourceSupplied, model_structureDetermined;
              ensures: model_sourceSupplied == true 
                       && model_structureDetermined == false;
          also
            public_exceptional_behavior
              requires: file == null
                        || (* file does not exist *);
            signals: (IOException);
         
      • setDestination

        void setDestination​(java.io.OutputStream output)
                     throws java.io.IOException
        Resets the Saver object and sets the destination to be the supplied InputStream.
        Parameters:
        output - the output stream
        Throws:
        java.io.IOException - if this Loader doesn't support loading from a File.
      • setRetrieval

        void setRetrieval​(int mode)
        Sets the retrieval mode
        Parameters:
        mode - an integer representing a retrieval mode
      • getFileExtension

        java.lang.String getFileExtension()
                                   throws java.lang.Exception
        Gets the file extension
        Returns:
        a string conatining the file extension (including the '.')
        Throws:
        java.lang.Exception - exception if a Saver not implementing FileSourcedConverter is used.
      • setFile

        void setFile​(java.io.File file)
              throws java.io.IOException
        Sets the output file
        Parameters:
        file - the output file
        Throws:
        java.io.IOException - exception if new output file cannot be set
      • setFilePrefix

        void setFilePrefix​(java.lang.String prefix)
                    throws java.lang.Exception
        Sets the file prefix. This method is used in the KnowledgeFlow GUI.
        Parameters:
        prefix - the prefix of the file name
        Throws:
        java.lang.Exception - exception if a Saver not implementing FileSourcedConverter is used.
      • filePrefix

        java.lang.String filePrefix()
                             throws java.lang.Exception
        Gets the file prefix This method is used in the KnowledgeFlow GUI.
        Returns:
        the prefix of the file name
        Throws:
        java.lang.Exception - exception if a Saver not implementing FileSourcedConverter is used.
      • setDir

        void setDir​(java.lang.String dir)
             throws java.io.IOException
        Sets the directory of the output file. This method is used in the KnowledgeFlow GUI.
        Parameters:
        dir - a string containing the path and name of the directory
        Throws:
        java.io.IOException - exception if a Saver not implementing FileSourcedConverter is used.
      • setDirAndPrefix

        void setDirAndPrefix​(java.lang.String relationName,
                             java.lang.String add)
                      throws java.io.IOException
        Sets the file prefix and the directory. This method is used in the KnowledgeFlow GUI.
        Parameters:
        relationName - the name of the realtion to be saved
        add - additional String for the file name
        Throws:
        java.io.IOException - exception if a Saver not implementing FileSourcedConverter is used.
      • retrieveDir

        java.lang.String retrieveDir()
                              throws java.io.IOException
        Gets the driectory of the output file This method is used in the KnowledgeFlow GUI.
        Returns:
        the directory as a string
        Throws:
        java.io.IOException - exception if a Saver not implementing FileSourcedConverter is used.
      • setInstances

        void setInstances​(Instances instances)
        Sets the instances to be saved
        Parameters:
        instances - the instances
      • writeBatch

        void writeBatch()
                 throws java.io.IOException
        Writes to a destination in batch mode
        Throws:
        java.io.IOException - throws exection if writting in batch mode is not possible
      • writeIncremental

        void writeIncremental​(Instance inst)
                       throws java.io.IOException
        Writes to a destination in incremental mode. If the instance is null, the outputfile will be closed.
        Parameters:
        inst - the instance to write, if null the output file is closed
        Throws:
        java.io.IOException - throws exception if incremental writting is not possible
      • getWriteMode

        int getWriteMode()
        Gets the write mode
        Returns:
        an integer representing the write mode