Mercurial > dive4elements > river
comparison artifacts/src/main/java/org/dive4elements/river/exports/process/Processor.java @ 7059:f9d5020af0af generator-refactoring
Remove AxisProcessor "glue" class and extend Processor interface
| author | Andre Heinecke <aheinecke@intevation.de> |
|---|---|
| date | Fri, 20 Sep 2013 10:30:03 +0200 |
| parents | 1b35b2ddfc28 |
| children | 253d80af5b7f |
comparison
equal
deleted
inserted
replaced
| 7058:5c07024cdc24 | 7059:f9d5020af0af |
|---|---|
| 9 package org.dive4elements.river.exports.process; | 9 package org.dive4elements.river.exports.process; |
| 10 | 10 |
| 11 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet; | 11 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet; |
| 12 import org.dive4elements.river.exports.XYChartGenerator; | 12 import org.dive4elements.river.exports.XYChartGenerator; |
| 13 import org.dive4elements.river.themes.ThemeDocument; | 13 import org.dive4elements.river.themes.ThemeDocument; |
| 14 import org.dive4elements.river.exports.DiagramGenerator; | |
| 14 | 15 |
| 15 /** | 16 /** |
| 16 * A processor is intended to generate an output e.g. curve in a chart diagramm from | 17 * A processor is intended to generate an output e.g. curve in a chart diagramm from |
| 17 * arbitrary data input which can be reused in several generators. | 18 * arbitrary data input which can be reused in several generators. |
| 18 * | 19 * |
| 19 * @author <a href="mailto:bjoern.ricks@intevation.de">Björn Ricks</a> | 20 * @author <a href="mailto:bjoern.ricks@intevation.de">Björn Ricks</a> |
| 20 */ | 21 */ |
| 21 public interface Processor { | 22 public interface Processor { |
| 23 /** | |
| 24 * Set the axis for this processor. | |
| 25 * This should be done before doOut is called for the first time. | |
| 26 * | |
| 27 * @param axisName The name of the Axis this processor should use. | |
| 28 */ | |
| 29 public void setAxisName(String axisName); | |
| 30 | |
| 31 /** | |
| 32 * Get the axis for this processor. | |
| 33 * | |
| 34 * @return The name of the axis that is used. | |
| 35 */ | |
| 36 public String getAxisName(); | |
| 22 | 37 |
| 23 /** | 38 /** |
| 24 * Processes data to generate e.g. a chart. | 39 * Processes data to generate e.g. a chart. |
| 25 * | 40 * |
| 26 * @param generator XYChartGenerator to add output on. | 41 * @param generator XYChartGenerator to add output on. |
| 27 * @param aandf The artifact and facet | 42 * @param aandf The artifact and facet |
| 28 * @param theme The theme that contains styling information. | 43 * @param theme The theme that contains styling information. |
| 29 * @param visible The visibility of the curve. | 44 * @param visible The visibility of the curve. |
| 30 * @param index The index of the curve | |
| 31 */ | 45 */ |
| 46 public void doOut( | |
| 47 DiagramGenerator generator, | |
| 48 ArtifactAndFacet aandf, | |
| 49 ThemeDocument theme, | |
| 50 boolean visible); | |
| 51 | |
| 52 /** | |
| 53 * Processes data to generate e.g. a chart. | |
| 54 * | |
| 55 * @param generator DiagramGenerator to add output on. | |
| 56 * @param aandf The artifact and facet | |
| 57 * @param theme The theme that contains styling information. | |
| 58 * @param visible The visibility of the curve. | |
| 59 * @param index The index of the curve | |
| 60 */ | |
| 61 @Deprecated | |
| 32 public void doOut( | 62 public void doOut( |
| 33 XYChartGenerator generator, | 63 XYChartGenerator generator, |
| 34 ArtifactAndFacet aandf, | 64 ArtifactAndFacet aandf, |
| 35 ThemeDocument theme, | 65 ThemeDocument theme, |
| 36 boolean visible, | 66 boolean visible, |