Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputMode.java @ 796:a5526908f92f
Added javadoc in state package.
gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Thu, 01 Apr 2010 09:15:36 +0000 |
| parents | c4156275c1e1 |
| children | 05bf8534a35a |
comparison
equal
deleted
inserted
replaced
| 795:cdade5005cba | 796:a5526908f92f |
|---|---|
| 4 | 4 |
| 5 import java.util.Collection; | 5 import java.util.Collection; |
| 6 import java.util.List; | 6 import java.util.List; |
| 7 | 7 |
| 8 /** | 8 /** |
| 9 * This is the interface description of an <code>OutputMode</code>. The | |
| 10 * methods defined here retrieve some basic information for an output. An output | |
| 11 * can be chart, histogram, statistic, csv, odv and so on. | |
| 12 * | |
| 9 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 13 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 10 * | 14 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> |
| 11 */ | 15 */ |
| 12 public interface OutputMode extends Serializable { | 16 public interface OutputMode extends Serializable { |
| 13 | 17 |
| 18 /** | |
| 19 * Retrieve the name of this output mode. | |
| 20 * | |
| 21 * @return the name of this output mode. | |
| 22 */ | |
| 14 public String getName(); | 23 public String getName(); |
| 15 | 24 |
| 25 /** | |
| 26 * Retrieve the description of an output. | |
| 27 * | |
| 28 * @return the description. | |
| 29 */ | |
| 16 public String getDescription(); | 30 public String getDescription(); |
| 17 | 31 |
| 32 /** | |
| 33 * Retrieve the mimetype used for the output. | |
| 34 * | |
| 35 * @return the mimetype. | |
| 36 */ | |
| 18 public String getMimeType(); | 37 public String getMimeType(); |
| 19 | 38 |
| 39 /** | |
| 40 * Retrieve a list of optional InputValue objects the user is able to | |
| 41 * adjust. | |
| 42 * | |
| 43 * @return optional input parameters. | |
| 44 */ | |
| 20 public Collection<InputValue> getInputParameters(); | 45 public Collection<InputValue> getInputParameters(); |
| 21 | 46 |
| 47 /** | |
| 48 * Retrieve a list of export modes this output can be exported to. | |
| 49 * | |
| 50 * @return some export modes. | |
| 51 */ | |
| 22 public List<ExportMode> getExportModes(); | 52 public List<ExportMode> getExportModes(); |
| 23 } | 53 } |
| 54 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |