Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.xssf.streaming
Class GZIPSheetDataWriter

    java.lang.Object
      org.apache.poi.xssf.streaming.SheetDataWriter
          org.apache.poi.xssf.streaming.GZIPSheetDataWriter

All Implemented Interfaces:
  java.io.Closeable

    public class GZIPSheetDataWriter

extends SheetDataWriter

Sheet writer that supports gzip compression of the temp files.

Constructor Summary
`GZIPSheetDataWriter()`
`GZIPSheetDataWriter(SharedStringsTable sharedStringsTable)`

Method Summary
`java.io.File` | `createTempFile()` Create a temp file to write sheet data.
`protected java.io.InputStream` | `decorateInputStream(java.io.FileInputStream fis)` Override this to translate (such as decrypt or expand) the file input stream as it is being read from disk.
`protected java.io.OutputStream` | `decorateOutputStream(java.io.FileOutputStream fos)` Override this to translate (such as encrypt or compress) the file output stream as it is being written to disk.

Methods inherited from class org.apache.poi.xssf.streaming.SheetDataWriter
`close, createWriter, finalize, getLastFlushedRow, getLowestIndexOfFlushedRows, getNumberOfCellsOfLastFlushedRow, getNumberOfFlushedRows, getTempFile, getWorksheetXMLInputStream, outputQuotedString, writeCell, writeRow`

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### GZIPSheetDataWriter

    public GZIPSheetDataWriter()
                        throws java.io.IOException

Throws:
  `java.io.IOException`

### GZIPSheetDataWriter

    public GZIPSheetDataWriter(SharedStringsTable sharedStringsTable)
                        throws java.io.IOException

Parameters:
  `sharedStringsTable` - the shared strings table, or null if inline text is used
Throws:
  `java.io.IOException`

Method Detail

### createTempFile

    public java.io.File createTempFile()
                                throws java.io.IOException

  Description copied from class: `SheetDataWriter`
  Create a temp file to write sheet data. By default, temp files are created in the default temporary-file directory with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override it and specify a different temp directory or filename or suffix, e.g. `.gz`

  Overrides:
    `createTempFile` in class `SheetDataWriter`
  Returns:
    temp file to write sheet data
  Throws:
    `java.io.IOException`

### decorateInputStream

    protected java.io.InputStream decorateInputStream(java.io.FileInputStream fis)
                                               throws java.io.IOException

  Description copied from class: `SheetDataWriter`
  Override this to translate (such as decrypt or expand) the file input stream as it is being read from disk. The default behavior is to to pass the stream through unmodified.

  Overrides:
    `decorateInputStream` in class `SheetDataWriter`
  Parameters:
    `fis` - the stream to decorate
  Returns:
    a decorated stream
  Throws:
    `java.io.IOException`
  See Also:
    `SheetDataWriter.decorateOutputStream(FileOutputStream)`

### decorateOutputStream

    protected java.io.OutputStream decorateOutputStream(java.io.FileOutputStream fos)
                                                 throws java.io.IOException

  Description copied from class: `SheetDataWriter`
  Override this to translate (such as encrypt or compress) the file output stream as it is being written to disk. The default behavior is to to pass the stream through unmodified.

  Overrides:
    `decorateOutputStream` in class `SheetDataWriter`
  Parameters:
    `fos` - the stream to decorate
  Returns:
    a decorated stream
  Throws:
    `java.io.IOException`
  See Also:
    `SheetDataWriter.decorateInputStream(FileInputStream)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.