Interface StreamingDatasetWriter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finish()
      Notifies the writer to close- all data has been written.
      void finishWithError​(java.lang.Exception e)
      Finishes the stream while indicating an error occurred.
      void initialize​(java.lang.String[] columnNames, java.lang.Class<?>[] columnTypes, boolean supportsQuality, int expectedRows)
      Initializes the streaming dataset with important information, primarily the column names and types.
      void write​(java.lang.Object[] data, QualityCode[] quality)
      Writes a row with the given data.
    • Method Detail

      • initialize

        void initialize​(java.lang.String[] columnNames,
                        java.lang.Class<?>[] columnTypes,
                        boolean supportsQuality,
                        int expectedRows)
        Initializes the streaming dataset with important information, primarily the column names and types. If supportsQuality is true, it is expected that every value added has an associated quality. expectedRows gives an idea as to how many rows will be returned- useful for progress indication. Should be -1 if the number cannot be known in advance.
        Parameters:
        expectedRows - -1 if not known, otherwise the number of rows that will be in the dataset.
      • write

        void write​(java.lang.Object[] data,
                   QualityCode[] quality)
            throws java.io.IOException
        Writes a row with the given data. Bounds and order of arrays must match that used to call initialize. quality may be null if dataset does not support quality.
        Throws:
        java.io.IOException
      • finish

        void finish()
        Notifies the writer to close- all data has been written. Should be called from a finally block.
      • finishWithError

        void finishWithError​(java.lang.Exception e)
        Finishes the stream while indicating an error occurred. Either this, or the successful finish(), must be called.