Package adams.flow.source

Class SpreadSheetDbReader

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DataRowTypeHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class SpreadSheetDbReader
extends AbstractSpreadSheetDbReader
    Returns a spreadsheet object generated from an SQL query.
    To optimize memory consumption, you can return the result of the query in chunks of a specified size.

    Input/output:
    - generates:
       adams.data.spreadsheet.SpreadSheet


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetDbReader
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -query <adams.db.SQLStatement> (property: query)
    The SQL query to use for generating the spreadsheet.
    default: select * from blah
 
    -data-row-type <DENSE|SPARSE> (property: dataRowType)
    The type of row to use for the data.
    default: DENSE
 
    -chunk-size <int> (property: chunkSize)
    The maximum number of rows per chunk; using -1 will read put all data into 
    a single spreadsheet object.
    default: -1
    minimum: -1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form