com.agimatec.utility.fileimport.spreadsheet

Class ExcelRowReader

java.lang.Object

com.agimatec.utility.fileimport.spreadsheet.ExcelRowReader

All Implemented Interfaces:

LineReader<ExcelRow>

public class ExcelRowReader
extends Object
implements LineReader<ExcelRow>

Description: read a spreadsheet line by line (each line is a )
User: roman.stumm
Date: 11.06.2008, 24.05.2013
Time: 18:03:51
Copyright: Viaboxx GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected ExcelFormat	format

Constructor Summary

Constructors

Constructor and Description
ExcelRowReader() create an instance that closes the stream on call of close() (keepOpen = false)
ExcelRowReader(boolean keepOpen)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close underlying stream (if keepOpen is false)
ExcelFormat	getFormat()
Iterator<org.apache.poi.ss.usermodel.Row>	getRowIterator()
org.apache.poi.ss.usermodel.Sheet	getSheet()
int	getSheetIndex()
String	getSheetName()
InputStream	getStream()
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
protected void	init()
boolean	isKeepOpen()
ExcelRow	readLine()
void	removeColumn(int columnNum)
void	removeCurrentRow(LineImportProcessor processor)
void	setFormat(ExcelFormat format)
void	setReader(Reader aReader)
void	setRowIterator(Iterator<org.apache.poi.ss.usermodel.Row> rowIterator)
void	setSheet(org.apache.poi.ss.usermodel.Sheet sheet)
void	setSheetIndex(int sheetIndex) sheet index is 0-based. sheetName has priority before sheetIndex.
void	setSheetName(String sheetName) set sheet name to import. if sheetName is set, the sheetIndex will be ignored.
void	setStream(InputStream aReader)
void	setWorkbook(org.apache.poi.ss.usermodel.Workbook workbook)

Methods inherited from class java.lang.Object

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

Field Detail

format

protected ExcelFormat format

Constructor Detail

ExcelRowReader

public ExcelRowReader(boolean keepOpen)

Parameters:

keepOpen - - true to prevent stream.close() on call of close()

Since:

2.5.13

ExcelRowReader

public ExcelRowReader()

create an instance that closes the stream on call of close() (keepOpen = false)

Method Detail

setSheetName

public void setSheetName(String sheetName)

set sheet name to import. if sheetName is set, the sheetIndex will be ignored.

Parameters:

sheetName -

Since:

2.5.13

getSheetName

public String getSheetName()

Since:

2.5.13

getSheetIndex

public int getSheetIndex()

isKeepOpen

public boolean isKeepOpen()

Returns:

true when stream not closed when close() called on receiver.

Since:

2.5.13

getFormat

public ExcelFormat getFormat()

Since:

2.5.25

setFormat

public void setFormat(ExcelFormat format)

Since:

2.5.25

setSheetIndex

public void setSheetIndex(int sheetIndex)

sheet index is 0-based. sheetName has priority before sheetIndex.

Parameters:

sheetIndex -

setReader

public void setReader(Reader aReader)
               throws IOException

Specified by:

setReader in interface LineReader<ExcelRow>

Parameters:

aReader -

Throws:

UnsupportedOperationException - - no ReaderInputStream support implemented yet!

IOException

setStream

public void setStream(InputStream aReader)
               throws IOException

Specified by:

setStream in interface LineReader<ExcelRow>

Throws:

IOException

readLine

public ExcelRow readLine()
                  throws IOException

Specified by:

readLine in interface LineReader<ExcelRow>

Returns:

the next line or null if no more lines available.

Throws:

IOException

init

protected void init()
             throws IOException,
                    ImporterException

Throws:

IOException

ImporterException - - invalid sheet name (sheet not found by name)

close

public void close()
           throws IOException

close underlying stream (if keepOpen is false)

Specified by:

close in interface LineReader<ExcelRow>

Throws:

IOException

getRowIterator

public Iterator<org.apache.poi.ss.usermodel.Row> getRowIterator()

setRowIterator

public void setRowIterator(Iterator<org.apache.poi.ss.usermodel.Row> rowIterator)

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

setSheet

public void setSheet(org.apache.poi.ss.usermodel.Sheet sheet)

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

setWorkbook

public void setWorkbook(org.apache.poi.ss.usermodel.Workbook workbook)

getStream

public InputStream getStream()

removeCurrentRow

public void removeCurrentRow(LineImportProcessor processor)

removeColumn

public void removeColumn(int columnNum)