Package com.github.cla9.excel.reader.sheet

Class SAXSheetHandler

java.lang.Object
com.github.cla9.excel.reader.sheet.AbstractSheetHandler
com.github.cla9.excel.reader.sheet.SAXSheetHandler
All Implemented Interfaces:
SheetHandler, org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler
Direct Known Subclasses:
SAXSheetExcelColumnHandler
public class SAXSheetHandler
extends AbstractSheetHandler
implements SheetHandler, org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler
The type Sax sheet handler.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected int currentCol
    The Current col.
    protected int currentRow
    The Current row.
    protected Range dataRange
    The Data range.
    protected Range headerRange
    The Header range.
    protected java.util.List<MergedArea> mergedAreas
    The Merged areas.
    protected java.util.List<java.lang.String> row
    The Row.
    protected java.util.function.Consumer<java.util.List<java.lang.String>> rowGenerationSuccessCallback
    The Row generation success callback.

    Fields inherited from class com.github.cla9.excel.reader.sheet.AbstractSheetHandler

    excelMetaModel, headerNames, order, sheetName

  • Constructor Summary

    Constructors 
    Constructor Description
    SAXSheetHandler​(ExcelMetaModel excelMetaModel, java.util.List<MergedArea> mergedAreas)
    Instantiates a new Sax sheet handler.

  • Method Summary

    Modifier and Type Method Description
    void cell​(java.lang.String cellReference, java.lang.String formattedValue, org.apache.poi.xssf.usermodel.XSSFComment comment)  
    protected void createEmptyCell​(int gap)
    Create empty cell.
    void endRow​(int rowNum)  
    java.util.List<java.lang.String> getHeaderNames()
    Gets header names.
    int[] getOrder()
    Get order int [ ].
    protected boolean isPass()
    Is pass boolean.
    void setRowGenerationSuccessCallback​(java.util.function.Consumer<java.util.List<java.lang.String>> rowGenerationSuccessCallback)
    Sets row generation success callback.
    void startRow​(int rowNum)  

    Methods inherited from class com.github.cla9.excel.reader.sheet.AbstractSheetHandler

    createOrder, reOrderHeaderName, validateHeader, validateOrder

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler

    endSheet, headerFooter

  • Field Details

    • currentRow

      protected int currentRow
      The Current row.

    • mergedAreas

      protected java.util.List<MergedArea> mergedAreas
      The Merged areas.

    • row

      protected java.util.List<java.lang.String> row
      The Row.

    • currentCol

      protected int currentCol
      The Current col.

    • dataRange

      protected Range dataRange
      The Data range.

    • headerRange

      protected Range headerRange
      The Header range.

    • rowGenerationSuccessCallback

      protected java.util.function.Consumer<java.util.List<java.lang.String>> rowGenerationSuccessCallback
      The Row generation success callback.

  • Constructor Details

    • SAXSheetHandler

      public SAXSheetHandler​(ExcelMetaModel excelMetaModel, java.util.List<MergedArea> mergedAreas)
      Instantiates a new Sax sheet handler.
      Parameters:
      excelMetaModel - the excel meta model
      mergedAreas - the merged areas

  • Method Details

    • setRowGenerationSuccessCallback

      public void setRowGenerationSuccessCallback​(java.util.function.Consumer<java.util.List<java.lang.String>> rowGenerationSuccessCallback)
      Sets row generation success callback.
      Parameters:
      rowGenerationSuccessCallback - the row generation success callback

    • startRow

      public void startRow​(int rowNum)
      Specified by:
      startRow in interface org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler

    • endRow

      public void endRow​(int rowNum)
      Specified by:
      endRow in interface org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler

    • cell

      public void cell​(java.lang.String cellReference, java.lang.String formattedValue, org.apache.poi.xssf.usermodel.XSSFComment comment)
      Specified by:
      cell in interface org.apache.poi.xssf.eventusermodel.XSSFSheetXMLHandler.SheetContentsHandler

    • createEmptyCell

      protected void createEmptyCell​(int gap)
      Create empty cell.
      Parameters:
      gap - the gap

    • getHeaderNames

      public java.util.List<java.lang.String> getHeaderNames()
      Description copied from interface: SheetHandler
      Gets header names.
      Specified by:
      getHeaderNames in interface SheetHandler
      Overrides:
      getHeaderNames in class AbstractSheetHandler
      Returns:
      the header names

    • getOrder

      public int[] getOrder()
      Description copied from interface: SheetHandler
      Get order int [ ].
      Specified by:
      getOrder in interface SheetHandler
      Overrides:
      getOrder in class AbstractSheetHandler
      Returns:
      the int [ ]

    • isPass

      protected boolean isPass()
      Is pass boolean.
      Returns:
      the boolean