Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/math/AttributedXYColumns.java @ 807:a645bd23c1c8
Added more javadoc. Removed trailing whitespace.
gnv-artifacts/trunk@889 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
---|---|
date | Thu, 08 Apr 2010 15:24:45 +0000 |
parents | d766fe2d917a |
children | 2e951160c43d |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/AttributedXYColumns.java Thu Apr 08 13:10:39 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/AttributedXYColumns.java Thu Apr 08 15:24:45 2010 +0000 @@ -9,24 +9,58 @@ import java.util.Map; /** - * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> - * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> + * Stores the results of a 3D interpolation. Used to generated the final + * products. + * + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> + * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */ public class AttributedXYColumns implements Serializable { + /** + * The list of height value column. + */ protected List<? extends XYColumn> columns; + + /** + * The extra input attributes which are not relevant + * for the interpolation but for generating the results. + */ protected Map attributes; + + /** + * The interpolation result. + */ protected Interpolation3D interpolation; + + /** + * Dataset to be used in a {@link de.intevation.gnv.jfreechart.PolygonPlot}. + */ protected PolygonDataset dataset; + /** + * Default constructor. + */ public AttributedXYColumns() { } + /** + * Constructor to create a AttributedXYColumns instance only + * with the height value columns. + * @param columns The height value columns. + */ public AttributedXYColumns(List<? extends XYColumn> columns) { this(columns, null); } + /** + * Constructor to create a AttributedXYColumns with + * height value columns and the attributes to be used to + * generate the results. + * @param columns The height value columns. + * @param attributes The external attributes. + */ public AttributedXYColumns( List<? extends XYColumn> columns, Map attributes @@ -35,12 +69,22 @@ this.attributes = attributes; } + /** + * Gets an attribute. + * @param key The key of the attribute. + * @return The attribute or null if no such attribue is found. + */ public Object getAttribute(Object key) { return attributes != null ? attributes.get(key) : null; } + /** + * Puts an attribute to the map of external attributes. + * @param key The key of the attribute. + * @param value The value of the attribute. + */ public void setAttribute(Object key, Object value) { if (attributes == null) { attributes = new HashMap(); @@ -48,28 +92,53 @@ attributes.put(key, value); } + /** + * Returns the list of height value columns. + * @return The list of height value columns. + */ public List<? extends XYColumn> getXYColumns() { return columns; } + /** + * Sets the list of height value columns. + * @param columns The new list of height value columns. + */ public void setXYColumns(List<? extends XYColumn> columns) { this.columns = columns; } + /** + * Sets the interpolation result. + * @param interpolation The new interpolation result. + */ public void setInterpolation(Interpolation3D interpolation) { this.interpolation = interpolation; } + /** + * Gets the interpolation results. + * @return The interpolation results. + */ public Interpolation3D getInterpolation() { return interpolation; } + /** + * Sets the generated polygon data set to be used in a + * {@link de.intevation.gnv.jfreechart.PolygonPlot}. + * @param dataset The polygon data set. + */ public void setPolygonDataset(PolygonDataset dataset) { this.dataset = dataset; } + /** + * Returns the polygon data set. + * @return The polygon data set. + */ public PolygonDataset getPolygonDataset() { return dataset; } } -// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file