cn.chenhuanming.octopus

Class Octopus

java.lang.Object

cn.chenhuanming.octopus.Octopus

public final class Octopus
extends Object

help you for simply import or output excel

Author:

chenhuanming Created at 2018/12/20

See Also:

ExcelReader, SheetReader, ExcelWriter, SheetWriter

Constructor Summary

Constructors

Constructor and Description
Octopus()

Method Summary

Modifier and Type	Method and Description
static ConfigFactory	getXMLConfigFactory(InputStream is) Deprecated.
static <T> SheetReader<T>	readBySheetName(InputStream is, String sheetName, Config config, CellPosition startPosition) read data from sheet by nodeName in excel
static <T> SheetReader<CheckedData<T>>	readBySheetNameWithValidation(InputStream is, String sheetName, Config config, CellPosition startPosition)
static <T> SheetReader<T>	readFirstSheet(InputStream is, Config config, CellPosition startPosition) read data from first sheet of excel
static <T> SheetReader<CheckedData<T>>	readFirstSheetWithValidation(InputStream is, Config config, CellPosition startPosition)
static <T> SheetReader<T>	readOneSheet(InputStream is, int index, Config config, CellPosition startPosition) read data from sheet at the specified position in excel
static <T> SheetReader<CheckedData<T>>	readOneSheetWithValidation(InputStream is, int index, Config config, CellPosition startPosition)
static <T> void	writeOneSheet(OutputStream os, Config config, String sheetName, Collection<T> data) write one sheet into excel file

Methods inherited from class java.lang.Object

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

Constructor Detail

Octopus

public Octopus()

Method Detail

getXMLConfigFactory

@Deprecated
public static ConfigFactory getXMLConfigFactory(InputStream is)

Deprecated.

read config from XML file

Parameters:

is - XML file

Returns:

configFactory

writeOneSheet

public static <T> void writeOneSheet(OutputStream os,
                                     Config config,
                                     String sheetName,
                                     Collection<T> data)
                              throws IOException

write one sheet into excel file

Type Parameters:

T - class type of data you want

Parameters:

os - excel file

config - get config through @{ConfigFactory}

sheetName - nodeName of sheet

data - data

Throws:

IOException - when writing excel file failed

readFirstSheet

public static <T> SheetReader<T> readFirstSheet(InputStream is,
                                                Config config,
                                                CellPosition startPosition)
                                         throws IOException,
                                                org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                                org.apache.poi.EncryptedDocumentException

read data from first sheet of excel

Type Parameters:

T - class type of data you want

Parameters:

is - excel file

config - get config through @{ConfigFactory}

startPosition - where to start read,starting from 0

Returns:

data

Throws:

IOException - if an error occurs while reading the data

org.apache.poi.openxml4j.exceptions.InvalidFormatException - if the contents of the file cannot be parsed into a Workbook

org.apache.poi.EncryptedDocumentException - If the workbook given is password protected

See Also:

DefaultCellPosition

readOneSheet

public static <T> SheetReader<T> readOneSheet(InputStream is,
                                              int index,
                                              Config config,
                                              CellPosition startPosition)
                                       throws IOException,
                                              org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                              org.apache.poi.EncryptedDocumentException

read data from sheet at the specified position in excel

Type Parameters:

T - class type of data you want

Parameters:

is - excel file

index - position,starting from 0

config - get config through @{ConfigFactory}

startPosition - where to start read,starting from 0

Returns:

data

Throws:

IOException - if an error occurs while reading the data

org.apache.poi.openxml4j.exceptions.InvalidFormatException - if the contents of the file cannot be parsed into a Workbook

org.apache.poi.EncryptedDocumentException - If the workbook given is password protected

readBySheetName

public static <T> SheetReader<T> readBySheetName(InputStream is,
                                                 String sheetName,
                                                 Config config,
                                                 CellPosition startPosition)
                                          throws IOException,
                                                 org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                                 org.apache.poi.EncryptedDocumentException,
                                                 SheetNotFoundException

read data from sheet by nodeName in excel

Type Parameters:

T - class type of data you want

Parameters:

is - excel file

sheetName - nodeName of sheet in the excel

config - get config through @{ConfigFactory}

startPosition - where to start read,starting from 0

Returns:

data

Throws:

IOException - if an error occurs while reading the data

org.apache.poi.openxml4j.exceptions.InvalidFormatException - if the contents of the file cannot be parsed into a Workbook

org.apache.poi.EncryptedDocumentException - If the workbook given is password protected

SheetNotFoundException - when none of sheets'nodeName is sheetName

readFirstSheetWithValidation

public static <T> SheetReader<CheckedData<T>> readFirstSheetWithValidation(InputStream is,
                                                                           Config config,
                                                                           CellPosition startPosition)
                                                                    throws IOException,
                                                                           org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                                                           org.apache.poi.EncryptedDocumentException

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException

org.apache.poi.EncryptedDocumentException

readOneSheetWithValidation

public static <T> SheetReader<CheckedData<T>> readOneSheetWithValidation(InputStream is,
                                                                         int index,
                                                                         Config config,
                                                                         CellPosition startPosition)
                                                                  throws IOException,
                                                                         org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                                                         org.apache.poi.EncryptedDocumentException

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException

org.apache.poi.EncryptedDocumentException

readBySheetNameWithValidation

public static <T> SheetReader<CheckedData<T>> readBySheetNameWithValidation(InputStream is,
                                                                            String sheetName,
                                                                            Config config,
                                                                            CellPosition startPosition)
                                                                     throws IOException,
                                                                            org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                                                                            org.apache.poi.EncryptedDocumentException,
                                                                            SheetNotFoundException

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException

org.apache.poi.EncryptedDocumentException

SheetNotFoundException