org.databene.formats.xls

Class XLSLineIterator

java.lang.Object

org.databene.formats.xls.XLSLineIterator

All Implemented Interfaces:

Closeable, AutoCloseable, DataIterator<Object[]>

public class XLSLineIterator
extends Object
implements DataIterator<Object[]>

Iterates the lines of a sheet in an Excel document. Created at 27.01.2009 22:04:47

Since:

0.4.8

Author:

Volker Bergmann

Constructor Summary

Constructors

Constructor and Description
XLSLineIterator(org.apache.poi.ss.usermodel.Sheet sheet, boolean headersIncluded, boolean formatted, org.databene.commons.Converter<String,?> stringPreprocessor)
XLSLineIterator(String uri)
XLSLineIterator(String uri, int sheetIndex)
XLSLineIterator(String uri, int sheetIndex, boolean headersIncluded, boolean formatted, org.databene.commons.Converter<String,?> stringPreprocessor)
XLSLineIterator(String uri, String sheetName, boolean headersIncluded, boolean formatted)
XLSLineIterator(String uri, String sheetName, boolean headersIncluded, boolean formatted, org.databene.commons.Converter<String,?> stringPreprocessor)

Method Summary

Modifier and Type	Method and Description
Object	cellValueForHeader(String header, Object[] cells)
void	close() Closes the iterator.
String	getEmptyMarker()
String[]	getHeaders()
String	getNullMarker()
Class<Object[]>	getType() Returns the type of the iterated elements.
boolean	isFormatted()
DataContainer<Object[]>	next(DataContainer<Object[]> wrapper) Returns the container with the next data element if available, otherwise null.
void	setEmptyMarker(String emptyMarker)
void	setFormatted(boolean formatted)
void	setHeaders(String[] headers)
void	setNullMarker(String nullMarker)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XLSLineIterator

public XLSLineIterator(String uri)
                throws IOException,
                       org.databene.commons.ParseException

Throws:

IOException

org.databene.commons.ParseException

XLSLineIterator

public XLSLineIterator(String uri,
                       int sheetIndex)
                throws IOException,
                       org.databene.commons.ParseException

Throws:

IOException

org.databene.commons.ParseException

XLSLineIterator

public XLSLineIterator(String uri,
                       int sheetIndex,
                       boolean headersIncluded,
                       boolean formatted,
                       org.databene.commons.Converter<String,?> stringPreprocessor)
                throws IOException,
                       org.databene.commons.ParseException

Throws:

IOException

org.databene.commons.ParseException

XLSLineIterator

public XLSLineIterator(String uri,
                       String sheetName,
                       boolean headersIncluded,
                       boolean formatted)
                throws IOException,
                       org.databene.commons.ParseException

Throws:

IOException

org.databene.commons.ParseException

XLSLineIterator

public XLSLineIterator(String uri,
                       String sheetName,
                       boolean headersIncluded,
                       boolean formatted,
                       org.databene.commons.Converter<String,?> stringPreprocessor)
                throws IOException,
                       org.databene.commons.ParseException

Throws:

IOException

org.databene.commons.ParseException

XLSLineIterator

public XLSLineIterator(org.apache.poi.ss.usermodel.Sheet sheet,
                       boolean headersIncluded,
                       boolean formatted,
                       org.databene.commons.Converter<String,?> stringPreprocessor)

Method Detail

getEmptyMarker

public String getEmptyMarker()

setEmptyMarker

public void setEmptyMarker(String emptyMarker)

getNullMarker

public String getNullMarker()

setNullMarker

public void setNullMarker(String nullMarker)

isFormatted

public boolean isFormatted()

setFormatted

public void setFormatted(boolean formatted)

getHeaders

public String[] getHeaders()

setHeaders

public void setHeaders(String[] headers)

getType

public Class<Object[]> getType()

Description copied from interface: DataIterator

Returns the type of the iterated elements.

Specified by:

getType in interface DataIterator<Object[]>

Returns:

the type of iterated data

next

public DataContainer<Object[]> next(DataContainer<Object[]> wrapper)

Description copied from interface: DataIterator

Returns the container with the next data element if available, otherwise null.

Specified by:

next in interface DataIterator<Object[]>

Parameters:

wrapper - a DataContainer to receive the iterated data

Returns:

a DataContainer that holds the next element, or null if none is available

cellValueForHeader

public Object cellValueForHeader(String header,
                                 Object[] cells)

close

public void close()

Description copied from interface: DataIterator

Closes the iterator.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataIterator<Object[]>

toString

public String toString()

Overrides:

toString in class Object