Package adams.flow.transformer

Class ReportDbUpdater

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DatabaseConnectionUser, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ReportDbUpdater
extends AbstractReportDbUpdater
    Adds all the data to the report (or reporthandler's report) passing through that the SQL statement returns.
    The {ID} placeholder can be used in the SQL statement to represent the current handler's ID.
    The following types of SQL statements are supported:
    - multiple rows of key-value pairs.
    - single row, with the key being the column name.


    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.report.MutableReportHandler
    - generates:
       adams.data.report.Report
       adams.data.report.MutableReportHandler


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ReportDbUpdater
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -sql <adams.db.SQLStatement> (property: SQL)
    The SQL statement that selects the key-value pairs for the report; you can 
    use the {ID} placeholder for the current handler's ID in your SQL statement 
    (if it is an adams.data.id.IDHandler).
    default: select key,value from table where id = \\\"{ID}\\\"
 
    -query-type <KEY_VALUE|COLUMN_AS_KEY> (property: queryType)
    The type of query that the SQL statement represents; multiple rows with 
    key-value pairs (KEY_VALUE) or single row with the column name as key (COLUMN_AS_KEY
    ).
    default: KEY_VALUE
 
    -column-key <java.lang.String> (property: columnKey)
    The name of the column containing the key for the key-value pairs to be 
    added to the report.
    default: key
 
    -column-value <java.lang.String> (property: columnValue)
    The name of the column containing the value for the key-value pairs to be 
    added to the report.
    default: value
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form