Package ch.rabanti.nanoxlsx4j.lowLevel

Class WorksheetReader

java.lang.Object
ch.rabanti.nanoxlsx4j.lowLevel.WorksheetReader
public class WorksheetReader extends Object
Class representing a reader for worksheets of XLSX files
Author:
Raphael Stoeckli

  • Constructor Details

    • WorksheetReader

      public WorksheetReader(SharedStringsReader sharedStrings, StyleReaderContainer styleReaderContainer, ImportOptions options)
      Constructor with parameters and import options
      Parameters:
      sharedStrings - SharedStringsReader object
      styleReaderContainer - Resolved styles, used to determine dates or times

  • Method Details

    • getData

      public Map<String,Cell> getData()
      Gets the data of the worksheet as Hashmap of cell address-cell object tuples
      Returns:
      Hashmap of cell address-cell object tuples

    • getStyleAssignment

      public Map<String,String> getStyleAssignment()
      Gets the assignment of resolved styles to cell addresses
      Returns:
      Map of cell address-style number tuples

    • getAutoFilterRange

      public Range getAutoFilterRange()
      gets the auto filter range
      Returns:
      Auto filter range if defined, otherwise null

    • getColumns

      public List<Column> getColumns()
      Gets a list of defined Columns
      Returns:
      List of columns

    • getDefaultColumnWidth

      public Float getDefaultColumnWidth()
      Gets the default column width
      Returns:
      Default column width if defined, otherwise null

    • getDefaultRowHeight

      public Float getDefaultRowHeight()
      Gets the default row height
      Returns:
      Default row height if defined, otherwise null

    • getRows

      public Map<Integer,ch.rabanti.nanoxlsx4j.lowLevel.WorksheetReader.RowDefinition> getRows()
      Gets a map of row definitions
      Returns:
      Map of row definitions, where the key is the row number and the value is an instance of WorksheetReader.RowDefinition

    • getMergedCells

      public List<Range> getMergedCells()
      Gets a list of merged cells
      Returns:
      List of Range definitions

    • getSelectedCells

      public List<Range> getSelectedCells()
      Gets the selected cell ranges (panes are currently not considered)
      Returns:
      Selected cell ranges if defined, otherwise null

    • getWorksheetProtection

      public Map<Worksheet.SheetProtectionValue,Integer> getWorksheetProtection()
      Gets the applicable worksheet protection values
      Returns:
      Map of Worksheet.SheetProtectionValue objects

    • getWorksheetProtectionHash

      public String getWorksheetProtectionHash()
      Gets the (legacy) password hash of a worksheet if protection values are applied with a password
      Returns:
      Hash value as string or null / empty if not defined

    • getPaneSplitValue

      public WorksheetReader.PaneDefinition getPaneSplitValue()
      Gets the definition of pane split-related information
      Returns:
      PaneDefinition object

    • isShowingGridLines

      public boolean isShowingGridLines()
      Gets whether grid lines are shown
      Returns:
      True if grid lines are visible

    • isShowingRowColHeaders

      public boolean isShowingRowColHeaders()
      Gets whether column and row headers are shown
      Returns:
      True if column and row header are visible

    • isShowingRuler

      public boolean isShowingRuler()
      Gets whether rulers are shown in view type: pageLayout
      Returns:
      True if rules are visible

    • getViewType

      public Worksheet.SheetViewType getViewType()
      Gets the sheet view type of the current worksheet
      Returns:
      Current view type

    • getCurrentZoomScale

      public int getCurrentZoomScale()
      Gets the zoom factor of the current view type
      Returns:
      Current zoom scale

    • getZoomFactors

      public Map<Worksheet.SheetViewType,Integer> getZoomFactors()
      Gets all preserved zoom factors of the worksheet
      Returns:
      Map of all zoom factors of the current worksheet

    • read

      public void read(InputStream stream) throws IOException
      Reads the XML file form the passed stream and processes the worksheet data
      Parameters:
      stream - Stream of the XML file
      Throws:
      IOException - thrown if the document could not be read

    • convertDoubleToInt

      public Object convertDoubleToInt(Object data)