ExcelChunkySAX Library

The ExcelChunkySAX library provides a convenient way to process large Excel files in chunks using a SAX parser. This library is especially useful when dealing with large Excel files, as it reads the file incrementally, enabling you to perform specific actions on each chunk of data. It utilizes the Apache POI library to read the Excel file and a SAX parser to parse the underlying XML data.

Installation

Maven

To install the ExcelChunkySAX library using Maven, add the following dependency to your pom.xml file:

<dependency>
    <groupId>com.mdazad.chunkysax</groupId>
    <artifactId>excel-chunky-sax</artifactId>
    <version>1.0.0</version>
</dependency>

Then, run the following command to update your project's dependencies:

mvn clean install

Gradle

To install the ExcelChunkySAX library using Gradle, add the following dependency to your build.gradle file:

dependencies {
    implementation 'com.mdazad.chunkysax:excel-chunky-sax:1.0.0'
}

Then, run the following command to update your project's dependencies:

./gradlew build

Please replace 1.0.0 with the actual version of your library.

Usage

To use the ExcelChunkySAX library, you need to implement the ChunkAction interface to define the action you want to perform on each chunk of data. Here's how you can use the library:

1. Implement the ChunkAction interface:

public class MyChunkAction implements ExcelChunkySAX.ChunkAction {
    @Override
    public void performActionsForChunk(List<?> chunkData, Boolean isLast) {
        // Define your action to be performed on each chunk of data
        if (isLast) {
            // This is the last chunk
        } else {
            // Process chunkData
        }
    }
}

2. Create an instance of the ExcelChunkySAX class and process the Excel file in chunks:

InputStream excelFileInputStream = ... // Provide the input stream of the Excel file
int chunkSize = ... // Specify the size of each chunk
ChunkAction myChunkAction = new MyChunkAction();

ExcelChunkySAX ExcelChunkySAX = new ExcelChunkySAX();
try {
    ExcelChunkySAX.processExcelFileInChunks(excelFileInputStream, chunkSize, myChunkAction);
} catch (Exception e) {
    // Handle any exceptions that may occur during processing
}

Alternatively, you can use the following one-liner to process the Excel file:

InputStream excelFileInputStream = ... // Provide the input stream of the Excel file
int chunkSize = ... // Specify the size of each chunk
ChunkAction myChunkAction = new MyChunkAction();

ExcelChunkySAX ExcelChunkySAX = new ExcelChunkySAX();
ExcelChunkySAX.processExcelFileInChunks(
    excelFileInputStream,
    chunkSize,
    (data, isLast) -> {
        System.out.println("isLast: " + isLast);
        System.out.println("data: " + data);
    }
);

Dependencies

This library depends on the following libraries:

• Apache POI
• SAX Parser

Important Note

The ExcelChunkySAX library will automatically convert any date formats it encounters in the Excel file to the "yyyy-MM-dd" format, as specified in the code.

License

This library is available under the MIT License. For more details, please refer to the LICENSE file.

Author

This library was developed by Md Azad.

• Email: mo.azad1999@gmail.com
• Organization: com.mdazad
• Organization URL: http://mdazad.com

Feel free to use this library to efficiently process large Excel files in your Java applications. If you encounter any issues or have suggestions for improvement, please don't hesitate to get in touch.