Package adams.data.io.input

Class ExcelSpreadSheetReader

  • All Implemented Interfaces:
    AdditionalInformationHandler, Destroyable, ErrorProvider, GlobalInfoSupporter, EncodingSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, MissingValueSpreadSheetReader, MultiSheetSpreadSheetReader<SheetRange>, NoHeaderSpreadSheetReader, SpreadSheetReader, WindowedSpreadSheetReader, DataRowTypeHandler, SpreadSheetTypeHandler, Serializable
    public class ExcelSpreadSheetReader
extends AbstractExcelSpreadSheetReader<SheetRange>
    Reads MS Excel files (using DOM). 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -data-row-type <adams.data.spreadsheet.DataRow> (property: dataRowType)
    The type of row to use for the data.
    default: adams.data.spreadsheet.DenseDataRow
 
    -spreadsheet-type <adams.data.spreadsheet.SpreadSheet> (property: spreadSheetType)
    The type of spreadsheet to use for the data.
    default: adams.data.spreadsheet.DefaultSpreadSheet
 
    -quiet <boolean> (property: quiet)
    If enabled, logging output in the spreadsheet is suppressed, e.g., from
    parsing errors of formulas.
    default: false
 
    -only-store-formulas <boolean> (property: onlyStoreFormulas)
    If enabled, formulas are only stored but never evaluated; useful for spreadsheets
    with unsupported functions in formulas.
    default: false
 
    -sheets <adams.data.spreadsheet.SheetRange> (property: sheetRange)
    The range of sheets to load.
    default: first
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; sheet names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); sheet names can be surrounded by double quotes.
 
    -missing <adams.core.base.BaseRegExp> (property: missingValue)
    The placeholder for missing values.
    default: ^(\\\\?|)$
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html
 
    -no-auto-extend-header <boolean> (property: autoExtendHeader)
    If enabled, the header gets automatically extended if rows have more cells
    than the header.
    default: true
 
    -text-columns <adams.core.Range> (property: textColumns)
    The range of columns to treat as text.
    default:
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -no-header <boolean> (property: noHeader)
    If enabled, all rows get added as data rows and a dummy header will get
    inserted.
    default: false
 
    -custom-column-headers <java.lang.String> (property: customColumnHeaders)
    The custom headers to use for the columns instead (comma-separated list);
     ignored if empty.
    default:
 
    -first-row <int> (property: firstRow)
    The index of the first row to retrieve (1-based).
    default: 1
    minimum: 1
 
    -num-rows <int> (property: numRows)
    The number of data rows to retrieve; use -1 for unlimited.
    default: -1
    minimum: -1
 
    -fill-empty-header-cells <boolean> (property: fillEmptyHeaderCells)
    If enabled, will use the formulas instead of the displayed text.
    default: true
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form