Package adams.data.io.input

Class ExcelStreamingSpreadSheetReader

  • All Implemented Interfaces:
    AdditionalInformationHandler, Destroyable, ErrorProvider, GlobalInfoSupporter, EncodingSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, MissingValueSpreadSheetReader, MultiSheetSpreadSheetReader<Range>, NoHeaderSpreadSheetReader, SpreadSheetReader, WindowedSpreadSheetReader, DataRowTypeHandler, SpreadSheetTypeHandler, Serializable
    public class ExcelStreamingSpreadSheetReader
extends AbstractExcelSpreadSheetReader<Range>
    Reads large MS Excel XML files (using streaming via SAX).
    Increasing the debug level to more than 1 results in outputting detailed information on cells. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -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
 
    -sheets <adams.core.Range> (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 '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -missing <java.lang.String> (property: missingValue)
    The placeholder for missing values.
    default: 
 
    -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
 
    -cell-type-id <adams.core.base.BaseString> [-cell-type-id ...] (property: cellTypeID)
    The IDs (= strings) for the cell types to parse.
    default: b, s
 
    -cell-type-contenttype <MISSING|STRING|BOOLEAN|LONG|DOUBLE|DATE|DATETIME|DATETIMEMSEC|TIME|TIMEMSEC|OBJECT> [-cell-type-contenttype ...] (property: cellTypeContentType)
    The corresponding content types for the cell types to parse.
    default: BOOLEAN, STRING
 
    -cell-string-id <adams.core.base.BaseString> [-cell-string-id ...] (property: cellStringID)
    The IDs (= strings) for the cell strings to parse.
    default: 
 
    -cell-string-contenttype <MISSING|STRING|BOOLEAN|LONG|DOUBLE|DATE|DATETIME|DATETIMEMSEC|TIME|TIMEMSEC|OBJECT> [-cell-string-contenttype ...] (property: cellStringContentType)
    The corresponding content types for the cell strings to parse.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • ExcelStreamingSpreadSheetReader

        public ExcelStreamingSpreadSheetReader()