Package adams.flow.transformer

Class ReportFileWriter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ReportFileWriter
extends AbstractReportFileWriter<Report>
    Saves a report to disk with the specified writer and passes the absolute filename on.
    As filename/directory name (depending on the writer) the database ID of the report is used (below the specified output directory).

    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.report.ReportHandler
    - generates:
       java.lang.String


    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: ReportFileWriter
 
    -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.
 
    -writer <adams.data.io.output.AbstractReportWriter> (property: writer)
    The writer to use for saving the reports.
    default: adams.data.io.output.DefaultSimpleReportWriter
 
    -dir <adams.core.io.PlaceholderDirectory> (property: outputDir)
    The output directory for the reports.
    default: ${CWD}
 
    -generator <adams.core.io.AbstractFilenameGenerator> (property: filenameGenerator)
    The filename generator to use for creating the filename for the report.
    default: adams.core.io.DefaultFilenameGenerator
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form