Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java @ 771:a0e63136954e
Added and repaired javadoc in de.intevation.gnv.exports package.
gnv-artifacts/trunk@827 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Thu, 25 Mar 2010 09:01:14 +0000 |
parents | f28a7eac542a |
children | 9a828e5a2390 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java Wed Mar 24 15:32:07 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java Thu Mar 25 09:01:14 2010 +0000 @@ -1,9 +1,5 @@ -/** - * - */ package de.intevation.gnv.exports; - import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; @@ -19,13 +15,21 @@ /** - * @author Tim Englich <tim.englich@intevation.de> + * This class is used to create a specific export document which is similar to + * an CSV document. * + * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> */ public class ODVExport extends DefaultExport { + /** + * Logger used for logging via log4j. + */ private static Logger log = Logger.getLogger(ODVExport.class); + /** + * Collection of parameters. + */ private Collection parameters = null; /** @@ -37,6 +41,10 @@ this.parameters = parameters; } + /** + * @see de.intevation.gnv.exports.Export#writeData(Profile, Collection, + * CSVWriter) + */ @Override protected void writeData(Profile profile, Collection result, CSVWriter writer) throws StateException { @@ -102,6 +110,15 @@ } } + /** + * This method is used to search specific value coresponding to its key + * <code>id</code> and return its description. + * + * @param values Collection of parameters. + * @param id Key used to find the value. + * + * @return Description of searched value. + */ protected String findParamTitle(Collection values, String id) { log.debug("find description of dataset"); @@ -119,3 +136,4 @@ } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :