Package gov.nasa.pds.objectAccess

Class TableWriter

  • public class TableWriter
extends java.lang.Object
    The TableWriter class is used for writing fixed-width text, fixed-width binary and delimited data files.

    • Constructor Summary

      Constructors 
      Constructor Description
      TableWriter​(java.lang.Object table, java.io.OutputStream outputStream)
      Creates an instance of TableWriter for writing to a fixed-width text or binary data file and uses "US-ASCII" character set name for encoding.
      TableWriter​(java.lang.Object table, java.io.OutputStream outputStream, java.lang.String charsetName)
      Creates an instance of TableWriter for writing to a fixed-width text or binary data file.
      TableWriter​(java.lang.Object table, java.io.Writer writer)
      Creates an instance of TableWriter for writing to a delimited data file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes this table writer which may no longer be used for writing records.
      TableRecord createRecord()
      Creates a record for adding data.
      void flush()
      Flushes the output stream or writer.
      void write​(TableRecord record)
      Writes the table record to the output stream or writer.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TableWriter

        public TableWriter​(java.lang.Object table,
                   java.io.OutputStream outputStream,
                   java.lang.String charsetName)
            throws java.nio.charset.UnsupportedCharsetException,
                   InvalidTableException
        Creates an instance of TableWriter for writing to a fixed-width text or binary data file. For fixed-width text file, 'carriage return + line feed' is used for record delimiter.
        Parameters:
        table - a table object
        outputStream - an output stream
        charsetName - the charset name to use for encoding the bytes.
        Throws:
        java.nio.charset.UnsupportedCharsetException
        InvalidTableException

      • TableWriter

        public TableWriter​(java.lang.Object table,
                   java.io.OutputStream outputStream)
            throws InvalidTableException
        Creates an instance of TableWriter for writing to a fixed-width text or binary data file and uses "US-ASCII" character set name for encoding. For fixed-width text file, 'carriage return + line feed' is used for record delimiter.
        Parameters:
        table - a table object
        outputStream - an output stream
        Throws:
        InvalidTableException

      • TableWriter

        public TableWriter​(java.lang.Object table,
                   java.io.Writer writer)
            throws InvalidTableException
        Creates an instance of TableWriter for writing to a delimited data file. It uses 'carriage return + line feed' for record delimiter.
        Parameters:
        table - a table object
        writer - a writer object
        Throws:
        InvalidTableException

    • Method Detail

      • createRecord

        public TableRecord createRecord()
        Creates a record for adding data.
        Returns:
        an instance of TableRecord

      • write

        public void write​(TableRecord record)
           throws java.io.IOException
        Writes the table record to the output stream or writer.
        Parameters:
        record - the TableRecord object
        Throws:
        java.io.IOException

      • flush

        public void flush()
           throws java.io.IOException
        Flushes the output stream or writer.
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Closes this table writer which may no longer be used for writing records.
        Throws:
        java.io.IOException