io.github.antoniovizuete.pojospreadsheet.core

Class AbstractSpreadsheet

java.lang.Object

io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet<Sheet>

io.github.antoniovizuete.pojospreadsheet.core.AbstractSpreadsheet

All Implemented Interfaces:

Spreadsheet, IntegerSet<Sheet>

Direct Known Subclasses:

SpreadsheetImpl

public class AbstractSpreadsheet
extends AbstractIntegerSet<Sheet>
implements Spreadsheet

The type Abstract spreadsheet.

Since:

0.1

Author:

Antonio Vizuete

Field Summary

Fields inherited from class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

set

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSpreadsheet(SpreadsheetWriter writer)

Method Summary

Modifier and Type	Method and Description
Sheet	addSheet() Add sheet sheet.
Sheet	addSheet(Integer index) Add sheet sheet.
Sheet	createItem(Integer index) Create item t.
SpreadsheetDecoration	getDecoration() Returns the SpreadsheetDecoration object.
Boolean	isFromReader() Is from reader boolean.
Sheet	newSheet() Returns a new SheetImpl instance.
OutputStream	performWrite() Converts the Spreadsheet to POI Workbook and writes it.
static Spreadsheet	read(String path) Reads the indicated Excel Workbook.
void	setFromReader(Boolean fromReader) Sets from reader.
Set<Sheet>	sheets() Sheets set.
byte[]	write() Writes the Excel Workbook.

Methods inherited from class io.github.antoniovizuete.pojospreadsheet.utils.iterator.AbstractIntegerSet

add, add, get, getMaxIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSpreadsheet

protected AbstractSpreadsheet(SpreadsheetWriter writer)

Method Detail

sheets

public Set<Sheet> sheets()

Description copied from interface: Spreadsheet

Sheets set.

Specified by:

sheets in interface Spreadsheet

Returns:

the set

createItem

public Sheet createItem(Integer index)

Description copied from interface: IntegerSet

Create item t.

Specified by:

createItem in interface IntegerSet<Sheet>

Parameters:

index - the index

Returns:

the t

isFromReader

public Boolean isFromReader()

Is from reader boolean.

Returns:

the boolean

setFromReader

public void setFromReader(Boolean fromReader)

Sets from reader.

Parameters:

fromReader - the from reader

addSheet

public Sheet addSheet()

Add sheet sheet.

Returns:

the sheet

addSheet

public Sheet addSheet(Integer index)

Add sheet sheet.

Parameters:

index - the index

Returns:

the sheet

newSheet

public Sheet newSheet()

Returns a new SheetImpl instance.

Specified by:

newSheet in interface Spreadsheet

Returns:

a new SheetImpl instance.

getDecoration

public SpreadsheetDecoration getDecoration()

Returns the SpreadsheetDecoration object.

Specified by:

getDecoration in interface Spreadsheet

Returns:

the SpreadsheetDecoration object.

write

public byte[] write()

Writes the Excel Workbook.

Specified by:

write in interface Spreadsheet

Returns:

the current instance.

See Also:

Spreadsheet.performWrite()

performWrite

public OutputStream performWrite()

Description copied from interface: Spreadsheet

Converts the Spreadsheet to POI Workbook and writes it.

Specified by:

performWrite in interface Spreadsheet

Returns:

the generic type instance

read

public static Spreadsheet read(String path)

Reads the indicated Excel Workbook.

NOTE: Currently, the Spreadsheet-Reader only reads the content of cells.

Parameters:

path - of the file

Returns:

the current instance.