Package com.northconcepts.datapipeline.excel

Enum Class ExcelDocument.ProviderType

java.lang.Object
java.lang.Enum<ExcelDocument.ProviderType>
com.northconcepts.datapipeline.excel.ExcelDocument.ProviderType
All Implemented Interfaces:
Serializable, Comparable<ExcelDocument.ProviderType>, Constable
Enclosing class:
ExcelDocument
public static enum ExcelDocument.ProviderType extends Enum<ExcelDocument.ProviderType>
Selects the Excel library (Apache POI or JXL) and workbook format an ExcelDocument uses.

  • Enum Constant Details

    • POI

      public static final ExcelDocument.ProviderType POI
      Read/Write .xls files (Excel 2003) using Apache POI.

    • POI_XSSF

      public static final ExcelDocument.ProviderType POI_XSSF
      Read/Write .xlsx files (Excel 2007+) using Apache POI. All data is held on the heap (in memory).

    • POI_SXSSF

      public static final ExcelDocument.ProviderType POI_SXSSF
      Writes .xlsx files (Excel 2007+) using Apache POI's streaming API (SXSSF) and temporary files to reduce memory usage. If used for reading, this provider reads using POI_XSSF, you should explicitly use POI_XSSF_SAX where streaming reads are needed.

    • POI_XSSF_SAX

      public static final ExcelDocument.ProviderType POI_XSSF_SAX
      Reads .xlsx files (Excel 2007+) using Apache POI's streaming API (XSSF_SAX) to reduce memory usage. If used for writing, this provider writes using POI_XSSF, you should explicitly use POI_SXSSF where streaming writes are needed.

    • JXL

      public static final ExcelDocument.ProviderType JXL
      Read/Write .xls files using JExcel/JXL.

    • POI_XSSFB

      public static final ExcelDocument.ProviderType POI_XSSFB
      Read .xlsb (Binary Excel) files using Apache POI.

  • Method Details

    • values

      public static ExcelDocument.ProviderType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ExcelDocument.ProviderType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • newProvider

      public abstract com.northconcepts.datapipeline.excel.Provider newProvider()
      Creates the provider implementing this type; each ExcelDocument calls it once when constructed.