Mercurial > dive4elements > gnv-client
changeset 958:d5d4dbda17cc
Add more Javadocs
gnv/trunk@1102 c6561f87-3c4e-4783-a992-168aeb5c3f6f
line wrap: on
line diff
--- a/gnv/ChangeLog Tue May 18 09:26:11 2010 +0000 +++ b/gnv/ChangeLog Tue May 18 09:51:41 2010 +0000 @@ -1,3 +1,15 @@ +2010-05-18 Tim Englich <tim.englich@intevation.de> + + * src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputParameter.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputMode.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultInputParameter.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultExportMode.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticsSet.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java: + Added more Javadoc. + 2010-05-18 Tim Englich <tim.englich@intevation.de> * src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java (doAdvance):
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java Tue May 18 09:51:41 2010 +0000 @@ -19,18 +19,63 @@ */ private static final long serialVersionUID = 8606869493141810364L; + /** + * The uuid of this Artifact which must be used to identify + * the artifact at the <code>ArtifactDatabase</code>. + */ private String id = null; + + /** + * The hash of the artifact which was send be the <code>ArtifactDatabase</code>. + */ private String hash = null; + + /** + * Flag which marks if the Artifact is currently selected or not. + */ private boolean selected = false; + /** + * The XML-Node of the current User-Interface + */ private Node currentUI = null; + + /** + * The XML-Nodes of the OutputModes. + */ private Node currentOut = null; + /** + * The ids of the states which could be reached. + */ private Collection<String> reachableStates; + + /** + * The parameters whcih could be feed to the artifact at the current state. + */ private Collection<String> inputParameter; + + /** + * The <code>OutputModes</code> that could be reached at the current state. + */ private Map<String, OutputMode> outputModes; + + /** + * The id of the state which is currently used. + */ private String currentState = null; + /** + * Constructor + * @param uuid the uuid of this Artifact which must be used to identify + * the artifact at the <code>ArtifactDatabase</code> + * @param hash the hash of the artifact which was send be the + * <code>ArtifactDatabase</code> + */ + public Artifact(String uuid, String hash) { + this.id = uuid; + this.hash = hash; + } public Node getCurrentUI() { return currentUI; @@ -71,16 +116,6 @@ this.currentState = currentState; } - /** - * Constructor - */ - public Artifact(String uuid, String hash) { - - this.id = uuid; - this.hash = hash; - } - - public String getHash() { return this.hash; }
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java Tue May 18 09:51:41 2010 +0000 @@ -1,6 +1,12 @@ package de.intevation.gnv.artifactdatabase.objects; /** + * Implementation of an <code>ArtifactObject> which represents an + * <code>ArtifactFactory</code> + * This Class provides the name, the description, the URL where the + * the <code>ArtifactDatabase</code> the factory belongs to could be reached + * and if the <code>ArtifacFactory</code> is currently selected or not. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> */ public class ArtifactFactory implements ArtifactObject { @@ -10,12 +16,25 @@ */ private static final long serialVersionUID = 5453748230625831527L; + /** + * The name of the factory. + */ private String name = null; + /** + * The description of the Factory. + */ private String description = null; + /** + * Flag which mark the Artifactfactory as selected if value is true + * unselected if value is false. + */ private boolean selected = false; + /** + * The URL where the Factory could be reached. + */ private String dataBaseUrl = null; /** @@ -33,7 +52,9 @@ * @param description the description of the Factory * @param dataBaseUrl the URL where the Factory could be reached. */ - public ArtifactFactory(String name, String description, String dataBaseUrl) { + public ArtifactFactory(String name, + String description, + String dataBaseUrl) { super(); this.name = name; this.description = description;
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java Tue May 18 09:51:41 2010 +0000 @@ -12,8 +12,14 @@ */ private static final long serialVersionUID = -8409111023127835398L; + /** + * The key of the new Value. + */ private String key = null; + /** + * The value of the Object. + */ private String value = null; /**
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticsSet.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticsSet.java Tue May 18 09:51:41 2010 +0000 @@ -16,12 +16,19 @@ */ private static final long serialVersionUID = 6738878381515708602L; + /** + * The name of the StatisticsSet. + */ private String name = null; + /** + * The statisticsvalues which belong to this set. + */ private Collection<ArtifactStatisticValue> statisticValues = new ArrayList<ArtifactStatisticValue>(); /** * Constructor + * @param name the name of the StatisticsSet */ public DefaultArtifactStatisticsSet(String name) { this.name = name;
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultExportMode.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultExportMode.java Tue May 18 09:51:41 2010 +0000 @@ -9,8 +9,19 @@ public class DefaultExportMode implements ExportMode { + /** + * The name of this parameter. + */ protected String name; + + /** + * The description of this mode. + */ protected String description; + + /** + * The mimetype used for this mode. + */ protected String mimeType; /**
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultInputParameter.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultInputParameter.java Tue May 18 09:51:41 2010 +0000 @@ -8,15 +8,23 @@ */ public class DefaultInputParameter implements InputParameter { + /** + * The UID of this Class. + */ private static final long serialVersionUID = 6597439837482244211L; + /** + * The name of this parameter. + */ private String name = null; + /** + * The values of this parameter. + */ private String[] values = null; /** * Constructor - * * @param name The name of this parameter. * @param values The values of this parameter. */
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputMode.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputMode.java Tue May 18 09:51:41 2010 +0000 @@ -15,14 +15,33 @@ */ private static final long serialVersionUID = 7487880486604174521L; + /** + * The name of the OutputMode + */ private String name = null; + /** + * The mimetype of the OutputMode + */ private String mimeType = null; + /** + * The parameters that could be used for this OutputMode + */ private Collection<OutputParameter> outputParameter = null; + /** + * The exports that can be called using this outputMode + */ private Map<String, ExportMode> exports; + /** + * Constructor + * @param name The name of the OutputMode + * @param mimeType The mimetype of the OutputMode + * @param outputParameter The parameters that could be used for this OutputMode + * @param exports The exports that can be called using this outputMode + */ public DefaultOutputMode( String name, String mimeType,
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputParameter.java Tue May 18 09:26:11 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultOutputParameter.java Tue May 18 09:51:41 2010 +0000 @@ -12,20 +12,33 @@ */ private static final long serialVersionUID = -8416057640116638152L; + /** + * The name of the parameter + */ private String name = null; + /** + * The value of the parameter + */ private String value = null; + /** + * The description of the parameter + */ private String description = null; + /** + * The type of the parameter + */ private String type = null; /** * Constructor * - * @param name - * @param value - * @param description + * @param name The name of the parameter + * @param value The value of the parameter + * @param description The description of the parameter + * @param type The type of the parameter */ public DefaultOutputParameter(String name, String value, String description, String type) {