# HG changeset patch # User Ingo Weinzierl # Date 1328187033 0 # Node ID 46ec09c7f578e13b258fc68c8ddda91ec065efb8 # Parent 958a10e2e246556c97e91bb051d765d9a6d9df16 Refactoring: moved more base code from XYChartGenerator into its parent class ChartGenerator. flys-artifacts/trunk@3878 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 958a10e2e246 -r 46ec09c7f578 flys-artifacts/ChangeLog --- a/flys-artifacts/ChangeLog Thu Feb 02 12:26:36 2012 +0000 +++ b/flys-artifacts/ChangeLog Thu Feb 02 12:50:33 2012 +0000 @@ -1,3 +1,13 @@ +2012-02-02 Ingo Weinzierl + + * src/main/java/de/intevation/flys/exports/XYChartGenerator.java, + src/main/java/de/intevation/flys/exports/ChartGenerator.java: Moved + further base code from XYChartGenerator into its ChartGenerator. + + * src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java: + Override generateChart() instead of generate() which is now implemented + in ChartGenerator. + 2012-02-02 Ingo Weinzierl * src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java: diff -r 958a10e2e246 -r 46ec09c7f578 flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Thu Feb 02 12:26:36 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java Thu Feb 02 12:50:33 2012 +0000 @@ -1,5 +1,6 @@ package de.intevation.flys.exports; +import java.awt.Color; import java.io.IOException; import java.io.OutputStream; import java.util.Locale; @@ -43,17 +44,15 @@ private static Logger logger = Logger.getLogger(ChartGenerator.class); - /** The default chart width, if no other width is set. */ - public static final int DEFAULT_CHART_WIDTH = 600; + public static final int DEFAULT_CHART_WIDTH = 600; + public static final int DEFAULT_CHART_HEIGHT = 400; + public static final String DEFAULT_CHART_FORMAT = "png"; + public static final Color DEFAULT_GRID_COLOR = Color.GRAY; + public static final float DEFAULT_GRID_LINE_WIDTH = 0.3f; + public static final int DEFAULT_FONT_SIZE = 12; + public static final String DEFAULT_FONT_NAME = "Tahoma"; - /** The default chart height, if no other height is set.*/ - public static final int DEFAULT_CHART_HEIGHT = 400; - /** The default chart format, if no other height is set.*/ - public static final String DEFAULT_CHART_FORMAT = "png"; - - /** The XPath that points to the chart size of the incoming request - * document.*/ public static final String XPATH_CHART_SIZE = "/art:action/art:attributes/art:size"; @@ -93,17 +92,119 @@ } + /** + * This method needs to be implemented by concrete subclasses to create new + * instances of JFreeChart. + * + * @return a new instance of a JFreeChart. + */ + public abstract JFreeChart generateChart(); + + + public abstract void doOut( + ArtifactAndFacet bundle, + Document attr, + boolean visible); + + protected abstract YAxisWalker getYAxisWalker(); + + /** + * Returns the default title of a chart. + * + * @return the default title of a chart. + */ protected abstract String getDefaultChartTitle(); + + /** + * Returns the default X-Axis label of a chart. + * + * @return the default X-Axis label of a chart. + */ protected abstract String getDefaultXAxisLabel(); + + /** + * This method is called to retrieve the default label for an Y axis at + * position pos. + * + * @param pos The position of an Y axis. + * + * @return the default Y axis label at position pos. + */ protected abstract String getDefaultYAxisLabel(int pos); - protected abstract void addSubtitles(JFreeChart chart); + + /** + * This method should be used by concrete subclasses to add subtitle to + * chart. The method in this implementation is empty. + * + * @param chart The JFreeChart chart object. + */ + protected void addSubtitles(JFreeChart chart) { + // do nothing + } + /** + * Generate chart. + */ + @Override + public void generate() + throws IOException + { + logger.debug("ChartGenerator.generate"); + + JFreeChart chart = generateChart(); + + String format = getFormat(); + int[] size = getSize(); + + if (size == null) { + size = getExportDimension(); + } + + context.putContextValue("chart.width", size[0]); + context.putContextValue("chart.height", size[1]); + + if (format.equals(ChartExportHelper.FORMAT_PNG)) { + context.putContextValue("chart.image.format", "png"); + + ChartExportHelper.exportImage( + out, + chart, + context); + } + else if (format.equals(ChartExportHelper.FORMAT_PDF)) { + preparePDFContext(context); + + ChartExportHelper.exportPDF( + out, + chart, + context); + } + else if (format.equals(ChartExportHelper.FORMAT_SVG)) { + prepareSVGContext(context); + + ChartExportHelper.exportSVG( + out, + chart, + context); + } + else if (format.equals(ChartExportHelper.FORMAT_CSV)) { + context.putContextValue("chart.image.format", "csv"); + + ChartExportHelper.exportCSV( + out, + chart, + context); + } + } + + + @Override public void init(Document request, OutputStream out, CallContext context) { logger.debug("ChartGenerator.init"); @@ -113,6 +214,7 @@ } + @Override public void setMasterArtifact(Artifact master) { this.master = master; } @@ -211,6 +313,195 @@ /** + * Returns the title of a chart. The return value depends on the existence + * of ChartSettings: if there are ChartSettings set, this method returns the + * chart title provided by those settings. Otherwise, this method returns + * getDefaultChartTitle(). + * + * @return the title of a chart. + */ + protected String getChartTitle() { + ChartSettings chartSettings = getChartSettings(); + + if (chartSettings != null) { + return getChartTitle(chartSettings); + } + + return getDefaultChartTitle(); + } + + + /** + * Returns the subtitle of a chart. The return value depends on the + * existence of ChartSettings: if there are ChartSettings set, this method + * returns the chart title provided by those settings. Otherwise, this + * method returns getDefaultChartSubtitle(). + * + * @return the subtitle of a chart. + */ + protected String getChartSubtitle() { + ChartSettings chartSettings = getChartSettings(); + + if (chartSettings != null) { + return getChartSubtitle(chartSettings); + } + + return getDefaultChartSubtitle(); + } + + + /** + * This method always returns null. Override it in subclasses that require + * subtitles. + * + * @return null. + */ + protected String getDefaultChartSubtitle() { + // Override this method in subclasses + return null; + } + + + /** + * This method is used to determine, if the chart's legend is visible or + * not. If a settings instance is set, this instance determines the + * visibility otherwise, this method returns true as default if no + * settings is set. + * + * @return true, if the legend should be visible, otherwise false. + */ + protected boolean isLegendVisible() { + ChartSettings chartSettings = getChartSettings(); + if (chartSettings != null) { + return isLegendVisible(chartSettings); + } + + return true; + } + + + /** + * This method is used to determine the font size of the chart's legend. If + * a settings instance is set, this instance determines the font + * size, otherwise this method returns 12 as default if no settings + * is set or if it doesn't provide a legend font size. + * + * @return a legend font size. + */ + protected int getLegendFontSize() { + Integer fontSize = null; + + ChartSettings chartSettings = getChartSettings(); + if (chartSettings != null) { + fontSize = getLegendFontSize(chartSettings); + } + + return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; + } + + + /** + * This method is used to determine if the resulting chart should display + * grid lines or not. Note: this method always returns true! + * + * @return true, if the chart should display grid lines, otherwise false. + */ + protected boolean isGridVisible() { + return true; + } + + + /** + * Returns the X-Axis label of a chart. + * + * @return the X-Axis label of a chart. + */ + protected String getXAxisLabel() { + ChartSettings chartSettings = getChartSettings(); + if (chartSettings == null) { + return getDefaultXAxisLabel(); + } + + AxisSection as = chartSettings.getAxisSection("X"); + if (as != null) { + String label = as.getLabel(); + + if (label != null) { + return label; + } + } + + return getDefaultXAxisLabel(); + } + + + /** + * This method returns the font size for the X axis. If the font size is + * specified in ChartSettings (if chartSettings is set), this size is + * returned. Otherwise the default font size 12 is returned. + * + * @return the font size for the x axis. + */ + protected int getXAxisLabelFontSize() { + ChartSettings chartSettings = getChartSettings(); + if (chartSettings == null) { + return DEFAULT_FONT_SIZE; + } + + AxisSection as = chartSettings.getAxisSection("X"); + Integer fontSize = as.getFontSize(); + + return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; + } + + + /** + * This method returns the font size for an Y axis. If the font size is + * specified in ChartSettings (if chartSettings is set), this size is + * returned. Otherwise the default font size 12 is returned. + * + * @return the font size for the x axis. + */ + protected int getYAxisFontSize(int pos) { + ChartSettings chartSettings = getChartSettings(); + if (chartSettings == null) { + return DEFAULT_FONT_SIZE; + } + + YAxisWalker walker = getYAxisWalker(); + + AxisSection as = chartSettings.getAxisSection(walker.getId(pos)); + Integer fontSize = as.getFontSize(); + + return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; + } + + + /** + * This method returns the export dimension specified in ChartSettings as + * int array [width,height]. + * + * @return an int array with [width,height]. + */ + protected int[] getExportDimension() { + ChartSettings chartSettings = getChartSettings(); + if (chartSettings == null) { + return new int[] { 600, 400 }; + } + + ExportSection export = chartSettings.getExportSection(); + Integer width = export.getWidth(); + Integer height = export.getHeight(); + + if (width != null && height != null) { + return new int[] { width, height }; + } + + return new int[] { 600, 400 }; + } + + + /** * Returns the Y-Axis label of a chart at position pos. * * @return the Y-Axis label of a chart at position 0. @@ -235,6 +526,12 @@ } + /** + * This helper mehtod is used to extract the current locale from instance + * vairable context. + * + * @return the current locale. + */ protected Locale getLocale() { CallMeta meta = context.getMeta(); PreferredLocale[] prefs = meta.getLanguages(); @@ -313,6 +610,13 @@ } + /** + * This method returns the format specified in the request document + * or DEFAULT_CHART_FORMAT if no format is specified in + * request. + * + * @return the format used to export this chart. + */ protected String getFormat() { String format = (String) XMLUtils.xpath( request, @@ -423,14 +727,6 @@ } - public abstract void doOut( - ArtifactAndFacet bundle, - Document attr, - boolean visible); - - public abstract void generate() throws IOException; - - /** * Returns an instance of EmptySettings currently! * @@ -469,5 +765,31 @@ return new IdentifiableNumberAxis(walker.getId(idx), label); } + + + protected void preparePDFContext(CallContext context) { + int[] dimension = getExportDimension(); + + context.putContextValue("chart.width", dimension[0]); + context.putContextValue("chart.height", dimension[1]); + context.putContextValue("chart.marginLeft", 5f); + context.putContextValue("chart.marginRight", 5f); + context.putContextValue("chart.marginTop", 5f); + context.putContextValue("chart.marginBottom", 5f); + context.putContextValue( + "chart.page.format", + ChartExportHelper.DEFAULT_PAGE_SIZE); + } + + + protected void prepareSVGContext(CallContext context) { + int[] dimension = getExportDimension(); + + context.putContextValue("chart.width", dimension[0]); + context.putContextValue("chart.height", dimension[1]); + context.putContextValue( + "chart.encoding", + ChartExportHelper.DEFAULT_ENCODING); + } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : diff -r 958a10e2e246 -r 46ec09c7f578 flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java Thu Feb 02 12:26:36 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java Thu Feb 02 12:50:33 2012 +0000 @@ -21,12 +21,12 @@ @Override - public void generate() - throws IOException - { + public JFreeChart generateChart() { logger.info("Generate Timeseries Chart."); logger.warn("TODO: IMPLEMENT ME!"); + + return null; } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : diff -r 958a10e2e246 -r 46ec09c7f578 flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Thu Feb 02 12:26:36 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Thu Feb 02 12:50:33 2012 +0000 @@ -188,11 +188,6 @@ /** The max Y range to include all Y values of all series for each axis. */ protected Map yRanges; - public static final Color DEFAULT_GRID_COLOR = Color.GRAY; - public static final float DEFAULT_GRID_LINE_WIDTH = 0.3f; - public static final int DEFAULT_FONT_SIZE = 12; - public static final String DEFAULT_FONT_NAME = "Tahoma"; - public XYChartGenerator() { xRanges = new HashMap(); @@ -202,272 +197,6 @@ /** - * Returns the title of a chart. The return value depends on the existence - * of ChartSettings: if there are ChartSettings set, this method returns the - * chart title provided by those settings. Otherwise, this method returns - * getDefaultChartTitle(). - * - * @return the title of a chart. - */ - protected String getChartTitle() { - ChartSettings chartSettings = getChartSettings(); - - if (chartSettings != null) { - return getChartTitle(chartSettings); - } - - return getDefaultChartTitle(); - } - - - protected abstract String getDefaultChartTitle(); - - - /** - * Returns the subtitle of a chart. The return value depends on the - * existence of ChartSettings: if there are ChartSettings set, this method - * returns the chart title provided by those settings. Otherwise, this - * method returns getDefaultChartSubtitle(). - * - * @return the subtitle of a chart. - */ - protected String getChartSubtitle() { - ChartSettings chartSettings = getChartSettings(); - - if (chartSettings != null) { - return getChartSubtitle(chartSettings); - } - - return getDefaultChartSubtitle(); - } - - - /** - * This method always returns null. Override it in subclasses that require - * subtitles. - * - * @return null. - */ - protected String getDefaultChartSubtitle() { - // Override this method in subclasses - return null; - } - - - /** - * This method is used to determine, if the chart's legend is visible or - * not. If a settings instance is set, this instance determines the - * visibility otherwise, this method returns true as default if no - * settings is set. - * - * @return true, if the legend should be visible, otherwise false. - */ - protected boolean isLegendVisible() { - ChartSettings chartSettings = getChartSettings(); - if (chartSettings != null) { - return isLegendVisible(chartSettings); - } - - return true; - } - - - /** - * This method is used to determine the font size of the chart's legend. If - * a settings instance is set, this instance determines the font - * size, otherwise this method returns 12 as default if no settings - * is set or if it doesn't provide a legend font size. - * - * @return a legend font size. - */ - protected int getLegendFontSize() { - Integer fontSize = null; - - ChartSettings chartSettings = getChartSettings(); - if (chartSettings != null) { - fontSize = getLegendFontSize(chartSettings); - } - - return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; - } - - - /** - * This method is used to determine if the resulting chart should display - * grid lines or not. Note: this method always returns true! - * - * @return true, if the chart should display grid lines, otherwise false. - */ - protected boolean isGridVisible() { - return true; - } - - - /** - * Returns the X-Axis label of a chart. - * - * @return the X-Axis label of a chart. - */ - protected String getXAxisLabel() { - ChartSettings chartSettings = getChartSettings(); - if (chartSettings == null) { - return getDefaultXAxisLabel(); - } - - AxisSection as = chartSettings.getAxisSection("X"); - if (as != null) { - String label = as.getLabel(); - - if (label != null) { - return label; - } - } - - return getDefaultXAxisLabel(); - } - - - /** - * Returns the default X-Axis label of a chart. - * - * @return the default X-Axis label of a chart. - */ - protected abstract String getDefaultXAxisLabel(); - - - /** - * This method is called to retrieve the default label for an Y axis at - * position pos. - * - * @param pos The position of an Y axis. - * - * @return the default Y axis label at position pos. - */ - protected abstract String getDefaultYAxisLabel(int pos); - - - /** - * This method returns the font size for the X axis. If the font size is - * specified in ChartSettings (if chartSettings is set), this size is - * returned. Otherwise the default font size 12 is returned. - * - * @return the font size for the x axis. - */ - protected int getXAxisLabelFontSize() { - ChartSettings chartSettings = getChartSettings(); - if (chartSettings == null) { - return DEFAULT_FONT_SIZE; - } - - AxisSection as = chartSettings.getAxisSection("X"); - Integer fontSize = as.getFontSize(); - - return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; - } - - - /** - * This method returns the font size for an Y axis. If the font size is - * specified in ChartSettings (if chartSettings is set), this size is - * returned. Otherwise the default font size 12 is returned. - * - * @return the font size for the x axis. - */ - protected int getYAxisFontSize(int pos) { - ChartSettings chartSettings = getChartSettings(); - if (chartSettings == null) { - return DEFAULT_FONT_SIZE; - } - - YAxisWalker walker = getYAxisWalker(); - - AxisSection as = chartSettings.getAxisSection(walker.getId(pos)); - Integer fontSize = as.getFontSize(); - - return fontSize != null ? fontSize : DEFAULT_FONT_SIZE; - } - - - /** - * This method returns the export dimension specified in ChartSettings as - * int array [width,height]. - * - * @return an int array with [width,height]. - */ - protected int[] getExportDimension() { - ChartSettings chartSettings = getChartSettings(); - if (chartSettings == null) { - return new int[] { 600, 400 }; - } - - ExportSection export = chartSettings.getExportSection(); - Integer width = export.getWidth(); - Integer height = export.getHeight(); - - if (width != null && height != null) { - return new int[] { width, height }; - } - - return new int[] { 600, 400 }; - } - - - /** - * Generate chart. - */ - public void generate() - throws IOException - { - logger.debug("XYChartGenerator.generate"); - - JFreeChart chart = generateChart(); - - String format = getFormat(); - int[] size = getSize(); - - if (size == null) { - size = getExportDimension(); - } - - context.putContextValue("chart.width", size[0]); - context.putContextValue("chart.height", size[1]); - - if (format.equals(ChartExportHelper.FORMAT_PNG)) { - context.putContextValue("chart.image.format", "png"); - - ChartExportHelper.exportImage( - out, - chart, - context); - } - else if (format.equals(ChartExportHelper.FORMAT_PDF)) { - preparePDFContext(context); - - ChartExportHelper.exportPDF( - out, - chart, - context); - } - else if (format.equals(ChartExportHelper.FORMAT_SVG)) { - prepareSVGContext(context); - - ChartExportHelper.exportSVG( - out, - chart, - context); - } - else if (format.equals(ChartExportHelper.FORMAT_CSV)) { - context.putContextValue("chart.image.format", "csv"); - - ChartExportHelper.exportCSV( - out, - chart, - context); - } - } - - - /** * Generate the chart anew (including localized axis and all). */ public JFreeChart generateChart() { @@ -511,32 +240,6 @@ } - protected void preparePDFContext(CallContext context) { - int[] dimension = getExportDimension(); - - context.putContextValue("chart.width", dimension[0]); - context.putContextValue("chart.height", dimension[1]); - context.putContextValue("chart.marginLeft", 5f); - context.putContextValue("chart.marginRight", 5f); - context.putContextValue("chart.marginTop", 5f); - context.putContextValue("chart.marginBottom", 5f); - context.putContextValue( - "chart.page.format", - ChartExportHelper.DEFAULT_PAGE_SIZE); - } - - - protected void prepareSVGContext(CallContext context) { - int[] dimension = getExportDimension(); - - context.putContextValue("chart.width", dimension[0]); - context.putContextValue("chart.height", dimension[1]); - context.putContextValue( - "chart.encoding", - ChartExportHelper.DEFAULT_ENCODING); - } - - /** * Put debug output about datasets. */