Package adams.flow.sink

Class XChartFileWriter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class XChartFileWriter
extends AbstractFileWriter
    Generates an XChart plot and writes the bitmap to a file.
    Dataset generation is skipped if the incoming data already represents a XChart dataset.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
       adams.gui.visualization.xchart.dataset.Datasets


    -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
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: XChartFileWriter
 
    -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 execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -output <adams.core.io.PlaceholderFile> (property: outputFile)
    The file to write the plot to
    default: ${CWD}
 
    -dataset <adams.gui.visualization.xchart.dataset.AbstractDatasetGenerator> (property: dataset)
    The dataset generator to use.
    default: adams.gui.visualization.xchart.dataset.XYDatasetGenerator
 
    -chart <adams.gui.visualization.xchart.chart.AbstractChartGenerator> (property: chart)
    The chart generator to use.
    default: adams.gui.visualization.xchart.chart.XYLineChart -color-provider adams.gui.visualization.core.DefaultColorProvider
 
    -marker <adams.gui.visualization.xchart.marker.AbstractMarkerGenerator> (property: marker)
    The marker generator to use for the data point markers for XY charts.
    default: adams.gui.visualization.xchart.marker.Default
 
    -width <int> (property: width)
    The width of the plot.
    default: 800
    minimum: -1
 
    -height <int> (property: height)
    The height of the plot.
    default: 600
    minimum: -1
 
    -watermark <adams.gui.visualization.watermark.Watermark> (property: watermark)
    The watermark to use for painting the data.
    default: adams.gui.visualization.watermark.Default
 
    -writer <adams.data.io.output.ImageWriter> (property: writer)
    The image writer to use.
    default: adams.data.io.output.JAIImageWriter
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • XChartFileWriter

        public XChartFileWriter()

    • Method Detail

      • setDataset

        public void setDataset​(AbstractDatasetGenerator value)
        Sets the dataset generator.
        Parameters:
        value - the generator

      • datasetTipText

        public String datasetTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setChart

        public void setChart​(AbstractChartGenerator value)
        Sets the chart generator.
        Parameters:
        value - the generator

      • chartTipText

        public String chartTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMarker

        public void setMarker​(AbstractMarkerGenerator value)
        Sets the marker generator for XY charts.
        Parameters:
        value - the generator

      • getMarker

        public AbstractMarkerGenerator getMarker()
        Returns the marker generator for XY charts.
        Returns:
        the generator

      • markerTipText

        public String markerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWidth

        public void setWidth​(int value)
        Sets the width of the plot.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the currently set width of the plot.
        Returns:
        the width

      • widthTipText

        public String widthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setHeight

        public void setHeight​(int value)
        Sets the height of the plot.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the currently set height of the plot.
        Returns:
        the height

      • heightTipText

        public String heightTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWatermark

        public void setWatermark​(Watermark value)
        Sets the watermark to use.
        Parameters:
        value - the watermark

      • getWatermark

        public Watermark getWatermark()
        Returns the watermark to use.
        Returns:
        the watermark

      • watermarkTipText

        public String watermarkTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWriter

        public void setWriter​(ImageWriter value)
        Sets the image writer.
        Parameters:
        value - the writer

      • getWriter

        public ImageWriter getWriter()
        Returns the image writer.
        Returns:
        the writer

      • writerTipText

        public String writerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message