daylightchart.sunchart.chart.SunChart.java Source code

Introduction

Here is the source code for daylightchart.sunchart.chart.SunChart.java

Source

/*
 *
 * Daylight Chart
 * http://sualeh.github.io/DaylightChart
 * Copyright (c) 2007-2016, Sualeh Fatehi.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
package daylightchart.sunchart.chart;

import java.awt.Color;
import java.awt.Font;
import java.time.Year;
import java.util.List;

import org.geoname.data.Location;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.xy.StandardXYItemRenderer;
import org.jfree.chart.title.TextTitle;
import org.jfree.chart.title.Title;
import org.jfree.data.xy.VectorSeries;
import org.jfree.data.xy.VectorSeriesCollection;
import org.jfree.ui.RectangleInsets;

import daylightchart.daylightchart.chart.ChartConfiguration;
import daylightchart.options.chart.ChartOptions;
import daylightchart.options.chart.ChartOptionsListener;
import daylightchart.sunchart.calculation.SunChartUtility;
import daylightchart.sunchart.calculation.SunChartYearData;
import daylightchart.sunchart.calculation.SunPosition;
import daylightchart.sunchart.calculation.SunPositions;

/**
 * Produces a chart of daylight times for any location.
 *
 * @author Sualeh Fatehi
 */
public class SunChart extends JFreeChart implements ChartOptionsListener {

    private static final long serialVersionUID = 7087394007991008310L;

    private final SunChartYearData sunChartData;

    /**
     * Create an empty chart, just to get the default chart options.
     */
    public SunChart() {
        this(SunChartUtility.createSunChartYear(null, Year.now().getValue()));
        setTitle("");
    }

    /**
     * Instantiate the chart for a given location, and given year.
     *
     * @param sunChartData
     *        Data for the chart, for the entire year
     */
    public SunChart(final SunChartYearData sunChartData) {
        super(new XYPlot());
        this.sunChartData = sunChartData;
        createChart();
    }

    /**
     * {@inheritDoc}
     *
     * @see daylightchart.options.chart.ChartOptionsListener#afterSettingChartOptions(ChartOptions)
     */
    @Override
    public void afterSettingChartOptions(final ChartOptions chartOptions) {
        Font titleFont;
        final TextTitle title = getTitle();
        if (title != null) {
            titleFont = title.getFont();
        } else {
            titleFont = ChartConfiguration.chartFont;
        }
        createTitles(chartOptions, titleFont.deriveFont(Font.BOLD, 18));
    }

    /**
     * {@inheritDoc}
     *
     * @see daylightchart.options.chart.ChartOptionsListener#beforeSettingChartOptions(ChartOptions)
     */
    @Override
    public void beforeSettingChartOptions(final ChartOptions chartOptions) {
        // No-op
    }

    private void createAltitudeAxis(final XYPlot plot) {
        final NumberAxis axis = new NumberAxis();
        axis.setTickLabelFont(ChartConfiguration.chartFont.deriveFont(Font.PLAIN, 12));
        //
        plot.setRangeAxis(axis);
    }

    private void createAzimuthAxis(final XYPlot plot) {
        final NumberAxis axis = new NumberAxis();
        axis.setTickLabelFont(ChartConfiguration.chartFont.deriveFont(Font.PLAIN, 12));
        axis.setVerticalTickLabels(true);
        //
        plot.setDomainAxis(axis);
    }

    /**
     * Creates bands for the sunrise and sunset times for the whole year.
     */
    private void createBandsInPlot(final XYPlot plot) {
        final VectorSeriesCollection vectorSeriesCollection = new VectorSeriesCollection();
        final List<SunPositions> sunPositionsList = sunChartData.getSunPositionsList();
        for (final SunPositions sunPositions : sunPositionsList) {
            final VectorSeries vectorSeries = new VectorSeries(sunPositions.getDate().toString());
            for (final SunPosition sunPosition : sunPositions) {
                vectorSeries.add(sunPosition.getAzimuth(), sunPosition.getAltitude(), 0, 0);
            }
            vectorSeriesCollection.addSeries(vectorSeries);
        }
        final int currentDatasetNumber = plot.getDatasetCount();
        plot.setDataset(currentDatasetNumber, vectorSeriesCollection);
    }

    /**
     * Creates the daylight chart.
     */
    private void createChart() {

        setBackgroundPaint(Color.white);

        final XYPlot plot = getXYPlot();

        plot.setRenderer(new StandardXYItemRenderer());
        plot.setBackgroundPaint(Color.white);

        plot.setAxisOffset(new RectangleInsets(5.0, 5.0, 5.0, 5.0));
        createAzimuthAxis(plot);
        createAltitudeAxis(plot);

        createBandsInPlot(plot);

    }

    @SuppressWarnings("unchecked")
    private void createTitles(final ChartOptions chartOptions, final Font titleFont) {

        // Clear all titles and subtitles
        setTitle((TextTitle) null);
        for (final Title subtitle : (List<Title>) getSubtitles()) {
            if (subtitle instanceof TextTitle) {
                removeSubtitle(subtitle);
            }
        }

        // Build new titles and legend
        final Location location = sunChartData.getLocation();
        final boolean showTitle = chartOptions.getTitleOptions().getShowTitle();
        if (location != null && showTitle) {
            final TextTitle title = new TextTitle(location.toString(), titleFont);
            setTitle(title);

            final Font subtitleFont = titleFont.deriveFont(Font.PLAIN);
            final TextTitle subtitle = new TextTitle(location.getDetails(), subtitleFont);
            subtitle.setPaint(title.getPaint());
            addSubtitle(subtitle);
        }
    }
}