com.northconcepts.datapipeline.excel

Enum ExcelDocument.ProviderType

java.lang.Object

java.lang.Enum<ExcelDocument.ProviderType>

com.northconcepts.datapipeline.excel.ExcelDocument.ProviderType

All Implemented Interfaces:

Serializable, Comparable<ExcelDocument.ProviderType>

Enclosing class:

ExcelDocument

public static enum ExcelDocument.ProviderType
extends Enum<ExcelDocument.ProviderType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
JXL Read/Write .xls files using JExcel/JXL.
POI Read/Write .xls files (Excel 2003) using Apache POI.
POI_SXSSF Writes .xlsx files (Excel 2007+) using Apache POI's streaming API (SXSSF) and temporary files to reduce memory usage.
POI_XSSF Read/Write .xlsx files (Excel 2007+) using Apache POI.
POI_XSSF_SAX Reads .xlsx files (Excel 2007+) using Apache POI's streaming API (XSSF_SAX) to reduce memory usage.

Method Summary

Modifier and Type	Method and Description
abstract com.northconcepts.datapipeline.excel.Provider	newProvider()
static ExcelDocument.ProviderType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExcelDocument.ProviderType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

Method Detail

values

public static ExcelDocument.ProviderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExcelDocument.ProviderType c : ExcelDocument.ProviderType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExcelDocument.ProviderType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

newProvider

public abstract com.northconcepts.datapipeline.excel.Provider newProvider()