dive4elements/river: flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java comparison

comparison flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java @ 2236:c2b15d9c0f43

Refactoring: moved more base code from XYChartGenerator into its parent class ChartGenerator flys-artifacts/trunk@3883 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Thu, 02 Feb 2012 14:00:40 +0000
parents	46ec09c7f578
children	23c7c51df772

comparison

equal deleted inserted replaced

-:ee5310134463
+:c2b15d9c0f43
 package de.intevation.flys.exports;
 import java.awt.Color;
+import java.awt.Font;
 import java.io.IOException;
 import java.io.OutputStream;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Locale;
 import javax.xml.xpath.XPathConstants;
 import org.apache.log4j.Logger;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.jfree.chart.JFreeChart;
+import org.jfree.chart.LegendItem;
 import org.jfree.chart.axis.NumberAxis;
 import org.jfree.data.Range;
 import de.intevation.artifacts.Artifact;
 import de.intevation.artifacts.CallContext;
 import de.intevation.flys.model.River;
 import de.intevation.flys.artifacts.FLYSArtifact;
 import de.intevation.flys.artifacts.resources.Resources;
 import de.intevation.flys.utils.FLYSUtils;
+import de.intevation.flys.utils.ThemeAccess;
 /**
 * The base class for chart creation. It should provide some basic things that
 * equal in all chart types.
 this.settings = settings;
 }
 /**
+* Returns an instance of <i>ChartSettings</i> with a chart specific section
+* but with no axes settings.
+*
+* @return an instance of <i>ChartSettings</i>.
+*/
+@Override
+public Settings getSettings() {
+if (this.settings != null) {
+return this.settings;
+}
+ChartSettings settings = new ChartSettings();
+ChartSection  chartSection  = buildChartSection();
+LegendSection legendSection = buildLegendSection();
+ExportSection exportSection = buildExportSection();
+settings.setChartSection(chartSection);
+settings.setLegendSection(legendSection);
+settings.setExportSection(exportSection);
+List<AxisSection> axisSections = buildAxisSections();
+for (AxisSection axisSection: axisSections) {
+settings.addAxisSection(axisSection);
+}
+return settings;
+}
+/**
+* Creates a new <i>ChartSection</i>.
+*
+* @return a new <i>ChartSection</i>.
+*/
+protected ChartSection buildChartSection() {
+ChartSection chartSection = new ChartSection();
+chartSection.setTitle(getChartTitle());
+chartSection.setSubtitle(getChartSubtitle());
+chartSection.setDisplayGird(isGridVisible());
+return chartSection;
+}
+/**
+* Creates a new <i>LegendSection</i>.
+*
+* @return a new <i>LegendSection</i>.
+*/
+protected LegendSection buildLegendSection() {
+LegendSection legendSection = new LegendSection();
+legendSection.setVisibility(isLegendVisible());
+legendSection.setFontSize(getLegendFontSize());
+return legendSection;
+}
+/**
+* Creates a new <i>ExportSection</i> with default values <b>WIDTH=600</b>
+* and <b>HEIGHT=400</b>.
+*
+* @return a new <i>ExportSection</i>.
+*/
+protected ExportSection buildExportSection() {
+ExportSection exportSection = new ExportSection();
+exportSection.setWidth(600);
+exportSection.setHeight(400);
+return exportSection;
+}
+/**
+* Creates a list of Sections that contains all axes of the chart (including
+* X and Y axes).
+*
+* @return a list of Sections for each axis in this chart.
+*/
+protected List<AxisSection> buildAxisSections() {
+List<AxisSection> axisSections = new ArrayList<AxisSection>();
+axisSections.addAll(buildXAxisSections());
+axisSections.addAll(buildYAxisSections());
+return axisSections;
+}
+/**
+* Creates a new Section for chart's X axis.
+*
+* @return a List that contains a Section for the X axis.
+*/
+protected List<AxisSection> buildXAxisSections() {
+List<AxisSection> axisSections = new ArrayList<AxisSection>();
+String identifier = "X";
+AxisSection axisSection = new AxisSection();
+axisSection.setIdentifier(identifier);
+axisSection.setLabel(getXAxisLabel());
+axisSection.setFontSize(14);
+axisSection.setFixed(false);
+// XXX We are able to find better default ranges that [0,0], but the Y
+// axes currently have no better ranges set.
+axisSection.setUpperRange(0d);
+axisSection.setLowerRange(0d);
+axisSections.add(axisSection);
+return axisSections;
+}
+/**
+* Creates a list of Section for the chart's Y axes. This method makes use
+* of <i>getYAxisWalker</i> to be able to access all Y axes defined in
+* subclasses.
+*
+* @return a list of Y axis sections.
+*/
+protected List<AxisSection> buildYAxisSections() {
+List<AxisSection> axisSections = new ArrayList<AxisSection>();
+YAxisWalker walker = getYAxisWalker();
+for (int i = 0, n = walker.length(); i < n; i++) {
+AxisSection ySection = new AxisSection();
+ySection.setIdentifier(walker.getId(i));
+ySection.setLabel(getYAxisLabel(i));
+ySection.setFontSize(14);
+ySection.setFixed(false);
+// XXX We are able to find better default ranges that [0,0], the
+// only problem is, that we do NOT have a better range than [0,0]
+// for each axis, because the initial chart will not have a dataset
+// for each axis set!
+ySection.setUpperRange(0d);
+ySection.setLowerRange(0d);
+axisSections.add(ySection);
+}
+return axisSections;
+}
+/**
+* Returns the <i>settings</i> as <i>ChartSettings</i>.
+*
+* @return the <i>settings</i> as <i>ChartSettings</i> or null, if
+* <i>settings</i> is not an instance of <i>ChartSettings</i>.
+*/
+public ChartSettings getChartSettings() {
+if (settings instanceof ChartSettings) {
+return (ChartSettings) settings;
+}
+return null;
+}
+/**
 * Returns the chart title provided by <i>settings</i>.
 *
 * @param settings A ChartSettings object.
 *
 * @return the title provided by <i>settings</i> or null if no
 return label;
 }
 }
 return getDefaultYAxisLabel(pos);
+}
+/**
+* This method searches for a specific axis in the <i>settings</i> if
+* <i>settings</i> is set. If the axis was found, this method returns the
+* specified axis range if the axis range is fixed. Otherwise, this method
+* returns null.
+*
+* @param axisId The identifier of an axis.
+*
+* @return the specified axis range from <i>settings</i> if the axis is
+* fixed, otherwise null.
+*/
+public Range getRangeForAxisFromSettings(String axisId) {
+ChartSettings chartSettings = getChartSettings();
+if (chartSettings == null) {
+return null;
+}
+AxisSection as = chartSettings.getAxisSection(axisId);
+Boolean  fixed = as.isFixed();
+if (fixed != null && fixed) {
+Double upper = as.getUpperRange();
+Double lower = as.getLowerRange();
+if (upper != null && lower != null) {
+return lower < upper
+? new Range(lower, upper)
+: new Range(upper, lower);
+}
+}
+return null;
 }
 /**
 * This helper mehtod is used to extract the current locale from instance
 return new int[] { DEFAULT_CHART_WIDTH, DEFAULT_CHART_HEIGHT };
 }
 /**
-* Returns an instance of <i>EmptySettings</i> currently!
-*
-* @return an instance of <i>EmptySettings</i>.
-*/
-public Settings getSettings() {
-return settings != null ? settings : new EmptySettings();
-}
-/**
-* Returns the <i>settings</i> as <i>ChartSettings</i>.
-*
-* @return the <i>settings</i> as <i>ChartSettings</i> or null, if
-* <i>settings</i> is not an instance of <i>ChartSettings</i>.
-*/
-public ChartSettings getChartSettings() {
-if (settings instanceof ChartSettings) {
-return (ChartSettings) settings;
-}
-return null;
-}
-/**
 * Creates a new instance of <i>IdentifiableNumberAxis</i>.
 *
 * @param idx The index of the new axis.
 * @param label The label of the new axis.
 *
 */
 protected NumberAxis createNumberAxis(int idx, String label) {
 YAxisWalker walker = getYAxisWalker();
 return new IdentifiableNumberAxis(walker.getId(idx), label);
+}
+/**
+* Creates a new LegendItem with <i>name</i> and font provided by
+* <i>createLegendLabelFont()</i>.
+*
+* @param theme The theme of the chart line.
+* @param The displayed name of the item.
+*
+* @return a new LegendItem instance.
+*/
+public LegendItem createLegendItem(Document theme, String name) {
+// OPTIMIZE Pass font, parsed Theme items.
+ThemeAccess themeAccess = new ThemeAccess(theme);
+Color      color       = themeAccess.parseLineColorField();
+LegendItem legendItem  = new LegendItem(name, color);
+legendItem.setLabelFont(createLegendLabelFont());
+return legendItem;
+}
+/**
+* Creates Font (Family and size) to use when creating Legend Items. The
+* font size depends in the return value of <i>getLegendFontSize()</i>.
+*
+* @return a new Font instance with <i>DEFAULT_FONT_NAME</i>.
+*/
+protected Font createLegendLabelFont() {
+return new Font(
+DEFAULT_FONT_NAME,
+Font.PLAIN,
+getLegendFontSize()
+);
 }
 protected void preparePDFContext(CallContext context) {
 int[] dimension = getExportDimension();

Mercurial > dive4elements > river

comparison flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java @ 2236:c2b15d9c0f43