Spreadsheet

java.lang.Object
- com.dpslink.base.util.Spreadsheet

All Implemented Interfaces:

java.io.Serializable
```
public class Spreadsheet
extends java.lang.Object
implements java.io.Serializable
```
A class to handle interaction with the Apache POI toolkit. Allows application classes to be insulated from POI details and provides methods typically needed by application code processing an Excel spreadsheet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Spreadsheet.CellRef` Inner class used to hold cell references (row & column) in a form.
`class`	`Spreadsheet.ColRef` Inner class used to hold column references in a form.

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.StringBuffer`	`A2Z` The letters of the alphabet from A through Z.
`private org.apache.poi.ss.usermodel.CreationHelper`	`ivCreateHelper` The instantiation helper for a workbook
`private org.apache.poi.ss.usermodel.Row`	`ivCurrentRow` The current spreadsheet row.
`private int`	`ivCurrentRowNum` The current spreadsheet row's number.
`private org.apache.poi.ss.usermodel.Sheet`	`ivCurrentSheet` The current sheet of the spreadsheet.
`private int`	`ivCurrentSheetNum` The current sheet index in the workbook.
`private org.apache.poi.ss.usermodel.DataFormat`	`ivDataFormat` The data format helper for a workbook
`private org.apache.poi.ss.usermodel.CellStyle`	`ivDateStyle` The default date style to use for cells that are not currently formatted as a date
`private java.text.DecimalFormat`	`ivNumericCellToString` A formatter used when a numeric cell is formatted as a `String`.
`private org.apache.poi.ss.usermodel.Drawing`	`ivPatriarch` The drawing patriarch for the current sheet.
`private org.apache.poi.ss.usermodel.CellStyle`	`ivTimeStyle` The default time style to use for cells that are not currently formatted as a time
`private org.apache.poi.ss.usermodel.Workbook`	`ivWorkBook` The main spreadsheet POI object.
`private static long`	`serialVersionUID` The class' serialization version id.
`static int`	`TYPE_XLS` Old-style XLS (HSSF) spreadsheet
`static int`	`TYPE_XLSX` XML-based XLSX (XSSF) spreadsheet
`static int`	`TYPE_XLSX_STREAMING` XML-based streaming XLSX (SXSSF) spreadsheet, small memory footprint with sliding window

Constructor Summary

Constructors
Constructor and Description
`Spreadsheet(java.io.File input)` Constructs a `Spreadsheet` based on an existing Excel file.
`Spreadsheet(java.io.InputStream input)` Constructs a `Spreadsheet` based on an existing Excel file.
`Spreadsheet(int type)` Constructs an empty `Spreadsheet`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRow()` Adds a new row and sets the current row cursor to the new row.
`void`	`addSheet(java.lang.String name)` Adds a new sheet.
`private void`	`clearCellHighlight(org.apache.poi.ss.usermodel.Cell cell)` Clears the highlighted attribute for the cell.
`void`	`clearCellHighlight(java.lang.String cellRef)` Clears the highlighted attribute for the cell.
`void`	`clearColumnHighlight(java.lang.String colRef)` Clears the highlighted attribute for the column in the current row..
`private org.apache.poi.ss.usermodel.CellStyle`	`cloneCellStyle(org.apache.poi.ss.usermodel.Cell cell)` Clones a cells style.
`static int`	`convertColStringToNum(java.lang.String colRef)` Takes an column reference as named in Excel (i.e.
`static java.lang.String`	`convertNumToColString(int colNum)` Takes a 0 based column number and converts to an Excel column name (i.e.
`void`	`deleteRow()` Removes the current row.
`private org.apache.poi.ss.usermodel.Cell`	`getCell(int rowNum, int colNum, boolean create)` Returns a cell given.
`private org.apache.poi.ss.usermodel.Cell`	`getCell(java.lang.String cellRef)` Returns a cell given an Excel style cell reference.
`private org.apache.poi.ss.usermodel.Cell`	`getCell(java.lang.String cellRef, boolean create)` Returns a cell given an Excel style cell reference.
`private java.lang.Object`	`getCellValue(org.apache.poi.ss.usermodel.Cell cell)` Retrieves the value of the cell as a `Object`.
`java.lang.Object`	`getCellValue(java.lang.String cellRef)` Retrieves the value of the cell as a `Object`.
`private boolean`	`getCellValueBoolean(org.apache.poi.ss.usermodel.Cell cell)` Retrieves the value of the cell as a `boolean`.
`boolean`	`getCellValueBoolean(java.lang.String cellRef)` Retrieves the value of the cell as a `boolean`.
`private java.util.Date`	`getCellValueDate(org.apache.poi.ss.usermodel.Cell cell)` Retrieves the value of the cell as a `Date`.
`java.util.Date`	`getCellValueDate(java.lang.String cellRef)` Retrieves the value of the cell as a `Date`.
`private double`	`getCellValueDouble(org.apache.poi.ss.usermodel.Cell cell)` Retrieves the value of the cell as a `double`.
`double`	`getCellValueDouble(java.lang.String cellRef)` Retrieves the value of the cell as a `double`.
`private java.lang.String`	`getCellValueString(org.apache.poi.ss.usermodel.Cell cell)` Retrieves the value of the cell as a `String`.
`java.lang.String`	`getCellValueString(java.lang.String cellRef)` Retrieves the value of the cell as a `String`.
`java.lang.String`	`getColumnRef(int index)` Returns a column index's Excel column reference (i.e.
`java.lang.Object`	`getColumnValue(java.lang.String colRef)` Retrieves the value of a column in the current row as a `Object`.
`boolean`	`getColumnValueBoolean(java.lang.String colRef)` Retrieves the value of a column in the current row as a `boolean`.
`java.util.Date`	`getColumnValueDate(java.lang.String colRef)` Retrieves the value of a column in the current row as a `Date`.
`double`	`getColumnValueDouble(java.lang.String colRef)` Retrieves the value of a column in the current row as a `double`.
`java.lang.String`	`getColumnValueString(java.lang.String colRef)` Retrieves the value of a column in the current row as a `String`.
`int`	`getCurrentRow()` Returns the current row number as counted by Excel (i.e.
`int`	`getCurrentSheet()` Returns the current sheet number (index).
`private org.apache.poi.ss.usermodel.Drawing`	`getDrawingPatriarch()` Returns the current sheet's drawing patriarch.
`int`	`getLastCellNumCurrentRow()` Returns the last cell index (0 based) of the current row.
`int`	`getNumberOfSheets()` Returns the number of sheets in the workbook.
`private java.text.DecimalFormat`	`getNumericCellToStringFormatter()` A formatter used to convert a numeric cell type to a string
`boolean`	`hasMoreRows()` Determines if more rows exist after the current row.
`boolean`	`hasMoreSheets()` Determines if more sheets exist after the current sheet.
`void`	`nextRow()` Sets the current row to the row following the current row.
`void`	`nextSheet()` Sets the current sheet to the sheet following the current sheet.
`void`	`setCellComment(java.lang.String cellRef, java.lang.String comment, java.lang.String author)` Sets a comment for a cell.
`private void`	`setCellHighlight(org.apache.poi.ss.usermodel.Cell cell)` Highlight the cell.
`void`	`setCellHighlight(java.lang.String cellRef)` Highlight the cell.
`private void`	`setCellValue(org.apache.poi.ss.usermodel.Cell cell, java.util.Date value)` Sets the value of a cell to a `Date`.
`private void`	`setCellValue(org.apache.poi.ss.usermodel.Cell cell, java.sql.Time value)` Sets the value of a cell to a `Date`.
`void`	`setCellValue(java.lang.String cellRef, java.util.Date value)` Set the value of the cell to a `Date`.
`void`	`setCellValue(java.lang.String cellRef, double value)` Set the value of the cell to a `double`.
`void`	`setCellValue(java.lang.String cellRef, java.lang.String value)` Set the value of the cell to a `String`.
`void`	`setColumnHighlight(java.lang.String colRef)` Highlight the column is the current row.
`void`	`setColumnImage(java.lang.String colRef, java.io.File file)` Set the value of a column in the current row to an image.
`void`	`setColumnImage(java.lang.String colRef, java.lang.String path)` Set the value of a column in the current row to an image.
`void`	`setColumnValue(java.lang.String colRef, java.util.Date value)` Set the value of a column in the current row to a `Date`.
`void`	`setColumnValue(java.lang.String colRef, double value)` Set the value of a column in the current row to a `double`.
`void`	`setColumnValue(java.lang.String colRef, java.lang.String value)` Set the value of a column in the current row to a `String`.
`void`	`setColumnValue(java.lang.String colRef, java.sql.Time value)` Set the value of a column in the current row to a `Date`.
`void`	`setCurrentRow(int rownum)` Sets the current row number using numbering used in Excel (i.e.
`boolean`	`setCurrentSheet(int index)` Sets the current sheet.
`boolean`	`setCurrentSheet(java.lang.String name)` Sets the current sheet.
`void`	`write(java.io.File out)` Writes the spreadsheet to a file.
`void`	`write(java.io.OutputStream out)` Writes the spreadsheet to a stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - TYPE_XLS
```
public static final int TYPE_XLS
```
    Old-style XLS (HSSF) spreadsheet
    
    See Also:
    
    Constant Field Values
  - TYPE_XLSX
```
public static final int TYPE_XLSX
```
    XML-based XLSX (XSSF) spreadsheet
    
    See Also:
    
    Constant Field Values
  - TYPE_XLSX_STREAMING
```
public static final int TYPE_XLSX_STREAMING
```
    XML-based streaming XLSX (SXSSF) spreadsheet, small memory footprint with sliding window
    
    See Also:
    
    Constant Field Values
  - A2Z
```
private static final java.lang.StringBuffer A2Z
```
    The letters of the alphabet from A through Z.
  - ivNumericCellToString
```
private java.text.DecimalFormat ivNumericCellToString
```
    A formatter used when a numeric cell is formatted as a String. Cannot be defined as a static because decimal formatters are not thread safe.
  - ivCurrentRow
```
private org.apache.poi.ss.usermodel.Row ivCurrentRow
```
    The current spreadsheet row.
  - ivCurrentRowNum
```
private int ivCurrentRowNum
```
    The current spreadsheet row's number.
  - ivCurrentSheet
```
private org.apache.poi.ss.usermodel.Sheet ivCurrentSheet
```
    The current sheet of the spreadsheet.
  - ivCurrentSheetNum
```
private int ivCurrentSheetNum
```
    The current sheet index in the workbook.
  - ivPatriarch
```
private org.apache.poi.ss.usermodel.Drawing ivPatriarch
```
    The drawing patriarch for the current sheet.
  - ivWorkBook
```
private org.apache.poi.ss.usermodel.Workbook ivWorkBook
```
    The main spreadsheet POI object.
  - ivDateStyle
```
private org.apache.poi.ss.usermodel.CellStyle ivDateStyle
```
    The default date style to use for cells that are not currently formatted as a date
  - ivTimeStyle
```
private org.apache.poi.ss.usermodel.CellStyle ivTimeStyle
```
    The default time style to use for cells that are not currently formatted as a time
  - ivCreateHelper
```
private org.apache.poi.ss.usermodel.CreationHelper ivCreateHelper
```
    The instantiation helper for a workbook
  - ivDataFormat
```
private org.apache.poi.ss.usermodel.DataFormat ivDataFormat
```
    The data format helper for a workbook
- Constructor Detail
  - Spreadsheet
```
public Spreadsheet(java.io.File input)
            throws java.io.IOException,
                   org.apache.poi.openxml4j.exceptions.InvalidFormatException
```
    Constructs a Spreadsheet based on an existing Excel file.
    
    Parameters:
    
    input - (File) File containing the existing XLS/XLSX file.
    
    Throws:
    
    java.io.IOException - if the file cannot be read.
    
    org.apache.poi.openxml4j.exceptions.InvalidFormatException - if the file is not a valid spreadsheet.
  - Spreadsheet
```
public Spreadsheet(java.io.InputStream input)
            throws java.io.IOException,
                   org.apache.poi.openxml4j.exceptions.InvalidFormatException
```
    Constructs a Spreadsheet based on an existing Excel file.
    
    Parameters:
    
    input - (InputStream) Stream containing the existing XLS/XLSX data.
    
    Throws:
    
    java.io.IOException - if the stream cannot be read.
    
    org.apache.poi.openxml4j.exceptions.InvalidFormatException - if the inputstream is not a valid spreadsheet.
  - Spreadsheet
```
public Spreadsheet(int type)
            throws java.io.IOException
```
    Constructs an empty Spreadsheet. For use when a spread sheet is not based on an existing file.
    
    Parameters:
    
    type - (int) The type of spreadsheet to create (XLS or XLSX).
    
    Throws:
    
    java.io.IOException
- Method Detail
  - addSheet
```
public void addSheet(java.lang.String name)
```
    Adds a new sheet. Sets the current sheet to the new sheet.
    
    Parameters:
    
    name - (String) The name of the desired sheet within the spreadsheet (case sensitive).
  - setCurrentSheet
```
public boolean setCurrentSheet(int index)
```
    Sets the current sheet.
    
    Parameters:
    
    index - (int) The index of the desired sheet within the spreadsheet (0 based).
    
    Returns:
    
    boolean - true if the current sheet set successfully, otherwise false.
  - setCurrentSheet
```
public boolean setCurrentSheet(java.lang.String name)
```
    Sets the current sheet.
    
    Parameters:
    
    name - (String) The name of the desired sheet within the spreadsheet (case sensitive).
    
    Returns:
    
    boolean - true if the current sheet set successfully, otherwise false.
  - getCurrentSheet
```
public int getCurrentSheet()
```
    Returns the current sheet number (index). This is zero based.
    
    Returns:
    
    int - The current sheet number.
  - getNumberOfSheets
```
public int getNumberOfSheets()
```
    Returns the number of sheets in the workbook.
    
    Returns:
    
    int - The number of sheets.
  - hasMoreSheets
```
public boolean hasMoreSheets()
```
    Determines if more sheets exist after the current sheet.
    
    Returns:
    
    boolean - true if the more sheets exist after the current sheet, otherwise false.
  - nextSheet
```
public void nextSheet()
```
    Sets the current sheet to the sheet following the current sheet.
  - getCellValueBoolean
```
public boolean getCellValueBoolean(java.lang.String cellRef)
```
    Retrieves the value of the cell as a boolean. If the cell type is not boolean, or can't be parsed as boolean, false is returned.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    boolean - The value of the cell.
  - getCellValueDate
```
public java.util.Date getCellValueDate(java.lang.String cellRef)
```
    Retrieves the value of the cell as a Date.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    Date - The value of the cell or null if the value cannot be converted to a date or if the cell does not exist.
  - getCellValueDouble
```
public double getCellValueDouble(java.lang.String cellRef)
```
    Retrieves the value of the cell as a double. If the cell type is not numeric, or can't be parsed as numeric, 0 is returned.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    double - The value of the cell.
  - getCellValueString
```
public java.lang.String getCellValueString(java.lang.String cellRef)
```
    Retrieves the value of the cell as a String. If the cell type is numeric, the numeric value will be converted using an internally defined decimal formatter.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    String - The value of the cell or null if the value cannot be converted to a string or if the cell does not exist.
  - getCellValue
```
public java.lang.Object getCellValue(java.lang.String cellRef)
```
    Retrieves the value of the cell as a Object. The returned object could be a String, Date, Double depending on the data and cell format.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    Object - The value of the cell or null if the cell does not exist.
  - setCellHighlight
```
public void setCellHighlight(java.lang.String cellRef)
```
    Highlight the cell. Currently implemented as a yellow background.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25").
  - clearCellHighlight
```
public void clearCellHighlight(java.lang.String cellRef)
```
    Clears the highlighted attribute for the cell.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25").
  - setCellValue
```
public void setCellValue(java.lang.String cellRef,
                         java.lang.String value)
```
    Set the value of the cell to a String. If the cell does not exist, it will be created.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25").
    
    value - (String) The new cell value.
  - setCellValue
```
public void setCellValue(java.lang.String cellRef,
                         double value)
```
    Set the value of the cell to a double. If the cell does not exist, it will be created.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25").
    
    value - (double) The new cell value.
  - setCellValue
```
public void setCellValue(java.lang.String cellRef,
                         java.util.Date value)
```
    Set the value of the cell to a Date. If the cell does not exist, it will be created.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25").
    
    value - (Date) The new cell value.
  - setCellComment
```
public void setCellComment(java.lang.String cellRef,
                           java.lang.String comment,
                           java.lang.String author)
```
    Sets a comment for a cell. *WARNING* POI 3.0.1 may corrupt existing spreadsheets when comments are added.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    comment - (String) The comment value.
  - getCurrentRow
```
public int getCurrentRow()
```
    Returns the current row number as counted by Excel (i.e. 1 based).
    
    Returns:
    
    int - The Excel row number.
  - setCurrentRow
```
public void setCurrentRow(int rownum)
```
    Sets the current row number using numbering used in Excel (i.e. 1 based). Creates the row, if it doesn't currently exist (unless row num is 0). If current row number is set to 0, then current row pointer is set to just before the actual first row, and the current row object is not valid until a nextRow() is executed.
    
    Parameters:
    
    rownum - (int) The row number as known to Excel.
  - hasMoreRows
```
public boolean hasMoreRows()
```
    Determines if more rows exist after the current row.
    
    Returns:
    
    boolean - true if the more rows exist after the current row, otherwise false.
  - getLastCellNumCurrentRow
```
public int getLastCellNumCurrentRow()
```
    Returns the last cell index (0 based) of the current row.
    
    Returns:
    
    int - The last cell index or -1 if no current row.
  - nextRow
```
public void nextRow()
```
    Sets the current row to the row following the current row.
  - addRow
```
public void addRow()
```
    Adds a new row and sets the current row cursor to the new row.
  - deleteRow
```
public void deleteRow()
```
    Removes the current row. Current row is null after the delete, but the row number does not change because rows are not renumbered.
  - getColumnRef
```
public java.lang.String getColumnRef(int index)
```
    Returns a column index's Excel column reference (i.e. "D" or "B").
    
    Parameters:
    
    index - (int) A column index (zero based).
    
    Returns:
    
    String - The column's Excel column reference.
  - getColumnValueBoolean
```
public boolean getColumnValueBoolean(java.lang.String colRef)
```
    Retrieves the value of a column in the current row as a boolean. The current row must be set. If the cell type is not boolean, or can't be parsed as boolean, false is returned.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    boolean - The value of the cell.
  - getColumnValueDate
```
public java.util.Date getColumnValueDate(java.lang.String colRef)
```
    Retrieves the value of a column in the current row as a Date. The current row must be set.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    Date - The value of the cell or null if the value cannot be converted to a date or if the cell does not exist.
  - getColumnValueDouble
```
public double getColumnValueDouble(java.lang.String colRef)
```
    Retrieves the value of a column in the current row as a double. The current row must be set. If the cell type is not numeric, or can't be parsed as numeric, 0 is returned.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    double - The value of the cell.
  - getColumnValueString
```
public java.lang.String getColumnValueString(java.lang.String colRef)
```
    Retrieves the value of a column in the current row as a String. The current row must be set. If the cell type is numeric, the numeric value will be converted using an internally defined decimal formatter.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    String - The value of the cell or null if the value cannot be converted to a string or if the cell does not exist.
  - getColumnValue
```
public java.lang.Object getColumnValue(java.lang.String colRef)
```
    Retrieves the value of a column in the current row as a Object. The current row must be set. The returned object could be a String, Date, Double depending on the data and cell format.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    Object - The value of the cell or null if the cell does not exist.
  - setColumnValue
```
public void setColumnValue(java.lang.String colRef,
                           java.lang.String value)
```
    Set the value of a column in the current row to a String. If the cell does not exist, it will be created.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    value - (String) The new cell value.
  - setColumnValue
```
public void setColumnValue(java.lang.String colRef,
                           double value)
```
    Set the value of a column in the current row to a double. If the cell does not exist, it will be created.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    value - (double) The new cell value.
  - setColumnValue
```
public void setColumnValue(java.lang.String colRef,
                           java.sql.Time value)
```
    Set the value of a column in the current row to a Date. If the cell does not exist, it will be created.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    value - (Date) The new cell value.
  - setColumnValue
```
public void setColumnValue(java.lang.String colRef,
                           java.util.Date value)
```
    Set the value of a column in the current row to a Date. If the cell does not exist, it will be created.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    value - (Date) The new cell value.
  - setColumnHighlight
```
public void setColumnHighlight(java.lang.String colRef)
```
    Highlight the column is the current row. Currently implemented as a yellow background.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
  - clearColumnHighlight
```
public void clearColumnHighlight(java.lang.String colRef)
```
    Clears the highlighted attribute for the column in the current row..
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
  - setColumnImage
```
public void setColumnImage(java.lang.String colRef,
                           java.lang.String path)
```
    Set the value of a column in the current row to an image. If the cell does not exist, it will be created.
    The supported image types are DIB, EMF, GIF, JPG, PICT, PNG and WMF.
    
    Images should only be added to a new workbook (vs. to an existing workbook).
    
    Unlike the setColumnValue methods, there is no corresponding getColumnImage method.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    path - (String) The full path to an image file.
  - setColumnImage
```
public void setColumnImage(java.lang.String colRef,
                           java.io.File file)
```
    Set the value of a column in the current row to an image. If the cell does not exist, it will be created.
    The supported image types are DIB, EMF, GIF, JPG, PICT, PNG and WMF.
    
    Images should only be added to a new workbook (vs. to an existing workbook).
    
    Unlike the setColumnValue methods, there is no corresponding getColumnImage method.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    file - (File) The file object for the image file.
  - write
```
public void write(java.io.File out)
           throws java.io.IOException
```
    Writes the spreadsheet to a file.
    
    Parameters:
    
    out - (File) The file to write data to.
    
    Throws:
    
    java.io.IOException - if the an error occurs during the write operation.
  - write
```
public void write(java.io.OutputStream out)
           throws java.io.IOException
```
    Writes the spreadsheet to a stream.
    
    Parameters:
    
    out - (OutputStream) The stream to write data to.
    
    Throws:
    
    java.io.IOException - if the an error occurs during the write operation.
  - convertColStringToNum
```
public static int convertColStringToNum(java.lang.String colRef)
```
    Takes an column reference as named in Excel (i.e. "A", "G", "AB") and converts it to a numeric column index for use in POI.
    
    Parameters:
    
    colRef - (String) The column reference using Excel terminology (i.e. "D" or "B")
    
    Returns:
    
    int - the column index (0 based).
  - convertNumToColString
```
public static java.lang.String convertNumToColString(int colNum)
```
    Takes a 0 based column number and converts to an Excel column name (i.e. "A", "G", "AB").
    
    Parameters:
    
    colNum - (int) The column index (0 based).
    
    Returns:
    
    String - The column reference using Excel terminology (i.e. "D" or "B")
  - getCell
```
private org.apache.poi.ss.usermodel.Cell getCell(java.lang.String cellRef)
```
    Returns a cell given an Excel style cell reference. Will return null if the cell does not currently exist.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    Returns:
    
    Cell - the requested cell or null, if it does not exist.
  - getCell
```
private org.apache.poi.ss.usermodel.Cell getCell(java.lang.String cellRef,
                                                 boolean create)
```
    Returns a cell given an Excel style cell reference.
    
    Parameters:
    
    cellRef - (String) The cell reference using Excel terminology (i.e. "D2" or "B25")
    
    create - (boolean) Flag determines if cell should be created if it does not currently exist.
    
    Returns:
    
    Cell - the requested cell or null, if does not exist and create not requested.
  - getCell
```
private org.apache.poi.ss.usermodel.Cell getCell(int rowNum,
                                                 int colNum,
                                                 boolean create)
```
    Returns a cell given.
    
    Parameters:
    
    rowNum - (int) Cell row number.
    
    colNum - (int) Cell column number.
    
    create - (boolean) Flag determines if cell should be created if it does not currently exist.
    
    Returns:
    
    Cell - the requested cell or null, if does not exist and create not requested.
  - getCellValueBoolean
```
private boolean getCellValueBoolean(org.apache.poi.ss.usermodel.Cell cell)
```
    Retrieves the value of the cell as a boolean.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    boolean - The value of the cell or false if the value cannot be converted to a boolean or if the cell does not exist.
  - getCellValueDate
```
private java.util.Date getCellValueDate(org.apache.poi.ss.usermodel.Cell cell)
```
    Retrieves the value of the cell as a Date.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    Date - The value of the cell or null if the value cannot be converted to a date or if the cell does not exist.
  - getCellValueDouble
```
private double getCellValueDouble(org.apache.poi.ss.usermodel.Cell cell)
```
    Retrieves the value of the cell as a double. If the cell type is not numeric, or can't be parsed as numeric, 0 is returned.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    double - The value of the cel.
  - getCellValueString
```
private java.lang.String getCellValueString(org.apache.poi.ss.usermodel.Cell cell)
```
    Retrieves the value of the cell as a String. If the cell type is numeric, the numeric value will be converted using an internally defined decimal formatter.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    String - The value of the cell or null if the value cannot be converted to a string or if the cell does not exist.
  - getCellValue
```
private java.lang.Object getCellValue(org.apache.poi.ss.usermodel.Cell cell)
```
    Retrieves the value of the cell as a Object. The returned object could be a String, Date, Double depending on the data and cell format.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    Object - The value of the cell or null if the cell does not exist.
  - setCellValue
```
private void setCellValue(org.apache.poi.ss.usermodel.Cell cell,
                          java.util.Date value)
```
    Sets the value of a cell to a Date.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    value - (Date) The new cell value.
  - setCellValue
```
private void setCellValue(org.apache.poi.ss.usermodel.Cell cell,
                          java.sql.Time value)
```
    Sets the value of a cell to a Date.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    value - (Time) The new cell value.
  - setCellHighlight
```
private void setCellHighlight(org.apache.poi.ss.usermodel.Cell cell)
```
    Highlight the cell. Currently implemented as a yellow background.
    
    Parameters:
    
    cell - (Cell) The cell.
  - cloneCellStyle
```
private org.apache.poi.ss.usermodel.CellStyle cloneCellStyle(org.apache.poi.ss.usermodel.Cell cell)
```
    Clones a cells style. Cloning is necessary because many cells may share the same style object. So, for example, if it is necessary to set a fill color for a single cell, we must create a new style unique to that cell that will have a special fill color.
    
    Parameters:
    
    cell - (Cell) The cell.
    
    Returns:
    
    CellStyle - a new style will all attributes copied from the existing cell's style.
  - clearCellHighlight
```
private void clearCellHighlight(org.apache.poi.ss.usermodel.Cell cell)
```
    Clears the highlighted attribute for the cell.
    
    Parameters:
    
    cell - (Cell) The cell.
  - getDrawingPatriarch
```
private org.apache.poi.ss.usermodel.Drawing getDrawingPatriarch()
```
    Returns the current sheet's drawing patriarch. ***WARNING** POI has no method to retrive a patriach from an existing sheet. So the first time this method is called for a sheet, the patriarch will be created and all drawings/comments on the current sheet will be removed.
    
    Returns:
    
    Drawing - The drawing patriarch.
  - getNumericCellToStringFormatter
```
private java.text.DecimalFormat getNumericCellToStringFormatter()
```
    A formatter used to convert a numeric cell type to a string
    
    Returns:
    
    DecimalFormat - The numeric formatter.

Class Spreadsheet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

TYPE_XLS

TYPE_XLSX

TYPE_XLSX_STREAMING

A2Z

ivNumericCellToString

ivCurrentRow

ivCurrentRowNum

ivCurrentSheet

ivCurrentSheetNum

ivPatriarch

ivWorkBook

ivDateStyle

ivTimeStyle

ivCreateHelper

ivDataFormat

Constructor Detail

Spreadsheet

Spreadsheet

Spreadsheet

Method Detail

addSheet

setCurrentSheet

setCurrentSheet

getCurrentSheet

getNumberOfSheets

hasMoreSheets

nextSheet

getCellValueBoolean

getCellValueDate

getCellValueDouble

getCellValueString

getCellValue

setCellHighlight

clearCellHighlight

setCellValue

setCellValue

setCellValue

setCellComment

getCurrentRow

setCurrentRow

hasMoreRows

getLastCellNumCurrentRow

nextRow

addRow

deleteRow

getColumnRef

getColumnValueBoolean

getColumnValueDate

getColumnValueDouble

getColumnValueString

getColumnValue

setColumnValue

setColumnValue

setColumnValue

setColumnValue

setColumnHighlight

clearColumnHighlight

setColumnImage

setColumnImage

write

write

convertColStringToNum

convertNumToColString

getCell

getCell

getCell

getCellValueBoolean

getCellValueDate

getCellValueDouble

getCellValueString

getCellValue

setCellValue