Class JFreeChartFileWriter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, ColorProviderHandler, Serializable, Comparable

    public class JFreeChartFileWriter
    extends AbstractFileWriter
    implements ColorProviderHandler
    Generates a JFreeChart plot and writes the bitmap to a file.

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


    -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: JFreeChartFileWriter
     
    -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
     
    -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
     
    -output <adams.core.io.PlaceholderFile> (property: outputFile)
        The file to write the plot to
        default: ${CWD}
     
    -dataset <adams.gui.visualization.jfreechart.dataset.AbstractDatasetGenerator> (property: dataset)
        The dataset generator to use.
        default: adams.gui.visualization.jfreechart.dataset.DefaultXY
     
    -chart <adams.gui.visualization.jfreechart.chart.AbstractChartGenerator> (property: chart)
        The chart generator to use.
        default: adams.gui.visualization.jfreechart.chart.XYLineChart
     
    -shape <adams.gui.visualization.jfreechart.shape.AbstractShapeGenerator> (property: shape)
        The shape generator to use for the data point markers.
        default: adams.gui.visualization.jfreechart.shape.Default
     
    -plot-color <java.awt.Color> (property: plotColor)
        The color for the plot.
        default: #0000ff
     
    -diagonal-color <java.awt.Color> (property: diagonalColor)
        The color for the diagonal (ie second data series if present).
        default: #000000
     
    -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
     
    -writer <adams.data.io.output.AbstractImageWriter> (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
    • Field Detail

      • m_PlotColor

        protected Color m_PlotColor
        the color for the plot.
      • m_ColorProvider

        protected ColorProvider m_ColorProvider
        the color provider for generating the colors (if more than one series).
      • m_DiagonalColor

        protected Color m_DiagonalColor
        the color for the diagonal plot.
      • m_Width

        protected int m_Width
        the width of the plot.
      • m_Height

        protected int m_Height
        the height of the plot.
      • m_Writer

        protected ImageWriter m_Writer
        the image writer to use.
    • Constructor Detail

      • JFreeChartFileWriter

        public JFreeChartFileWriter()
    • 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.
      • setShape

        public void setShape​(AbstractShapeGenerator value)
        Sets the shape generator.
        Parameters:
        value - the generator
      • shapeTipText

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

        public void setPlotColor​(Color value)
        Sets the color for the plot.
        Parameters:
        value - the color
      • getPlotColor

        public Color getPlotColor()
        Returns the color for the plot.
        Returns:
        the color
      • plotColorTipText

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

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the gui
      • setDiagonalColor

        public void setDiagonalColor​(Color value)
        Sets the color for the diagonal (ie second data series if present).
        Parameters:
        value - the color
      • getDiagonalColor

        public Color getDiagonalColor()
        Returns the color for the diagonal (ie second data series if present).
        Returns:
        the color
      • diagonalColorTipText

        public String diagonalColorTipText()
        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.
      • 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.
        Specified by:
        accepts in interface InputConsumer
        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