com.northconcepts.datapipeline.excel

Class ExcelDocument

java.lang.Object

com.northconcepts.datapipeline.excel.ExcelDocument

All Implemented Interfaces:

Closeable, AutoCloseable

public class ExcelDocument
extends Object
implements Closeable

The in-memory abstraction for an Excel workbook. This object is not thread-safe and will throw an exception if used in multiple ExcelReaders and/or ExcelWriter concurrently. Since its data is stored in memory, reading and re-reading from it multiple times is very cheap (think millions of reads per second).

See Also:

ExcelReader, ExcelWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExcelDocument.ProviderType

Constructor Summary

Constructors

Constructor and Description
ExcelDocument()
ExcelDocument(ExcelDocument.ProviderType providerType)

Method Summary

Modifier and Type	Method and Description
void	close() The method can be called when this document can be discarded, but it will be called automatically in the finalize() method.
protected void	finalize()
File	getFile()
ExcelDocument.ProviderType	getProviderType()
String[]	getSheetNames()
boolean	isClosed()
ExcelDocument	open(File file)
ExcelDocument	open(InputStream inputStream)
ExcelDocument	save(File file)
ExcelDocument	save(OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelDocument

public ExcelDocument()

ExcelDocument

public ExcelDocument(ExcelDocument.ProviderType providerType)

Method Detail

getProviderType

public ExcelDocument.ProviderType getProviderType()

open

public ExcelDocument open(InputStream inputStream)

open

public ExcelDocument open(File file)

close

public void close()

The method can be called when this document can be discarded, but it will be called automatically in the finalize() method. It's safe to call this method multiple times -- subsequent calls will do nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

save

public ExcelDocument save(OutputStream outputStream)

save

public ExcelDocument save(File file)

getSheetNames

public String[] getSheetNames()

getFile

public File getFile()