# HG changeset patch # User Ingo Weinzierl # Date 1270032754 0 # Node ID 9b9bf42b7928c02ec122f126d5ff5c222d83c5b3 # Parent 23877dd6944477439a245755e7a1ca19f4864dba Added and repaired JavaDoc in artifacts package. gnv-artifacts/trunk@874 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/ChangeLog --- a/gnv-artifacts/ChangeLog Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/ChangeLog Wed Mar 31 10:52:34 2010 +0000 @@ -1,3 +1,21 @@ +2010-03-31 Ingo Weinzierl + + * src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java, + src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java, + src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java, + src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java, + src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java, + src/main/java/de/intevation/gnv/artifacts/ressource/RessourceFactory.java: + Added and repaired JavaDoc. + 2010-03-31 Ingo Weinzierl * src/main/java/de/intevation/gnv/artifacts/cache/CacheFactory.java: Added diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java Wed Mar 31 10:52:34 2010 +0000 @@ -39,6 +39,11 @@ import org.w3c.dom.NodeList; /** + * This artifact is used to handle to input/output at the beginning of a + * parameterization when no product has been selected so far. After the user + * having selected a product, this artifact is replaced by a concrete product + * artifact. + * * @author Ingo Weinzierl */ public class SelectProductArtifact extends GNVDefaultArtifact { @@ -48,17 +53,37 @@ */ private static final long serialVersionUID = -7952357683127758677L; + /** + * Path to uuid. + */ public static final String XPATH_UUID = "art:action/art:uuid/@value"; + /** + * Path to hash. + */ public static final String XPATH_HASH = "art:action/art:hash/@value"; + /** + * Path to selected product. + */ public static final String XPATH_INPUT_DATA_VALUE = "art:action/art:data/art:input[@name='product']/@value"; + /** + * Path to parameters required by the factory. + */ public static final String XPATH_SETUP_PARAMETER_NODES = "/art:action/art:factory/art:parameter"; + /** + * + */ public static final String XFORM_URL = "http://www.w3.org/2002/xforms"; + + /** + * Prefix used in the user interface description part of the describe + * document. + */ public static final String XFORM_PREFIX = "xform"; private static Logger log = Logger.getLogger(SelectProductArtifact.class); @@ -70,11 +95,23 @@ private Map preSettings = null; + /** + * Constructor. + */ public SelectProductArtifact() { super(); } + /** + * Initialize this artifact and parse all required information from + * data document. + * + * @param identifier + * @param factory + * @param context + * @param data + */ @Override public void setup( String identifier, @@ -112,11 +149,23 @@ } + /** + * + * @param products + */ public void setProducts(Map products) { this.products = products; } + /** + * Search for a selected product and create a new concrecte product artifact + * with this information. + * + * @param target Document which contains the selected product. + * @param context CallContext. + * @return Error or success message. + */ @Override public Document feed(Document target, CallContext context) { log.debug("SelectProductArtifact.feed()"); @@ -166,6 +215,15 @@ } + /** + * If {@link #feed(org.w3c.dom.Document, de.intevation.artifacts.CallContext)} + * was sucessfully called before, this artifact is replaced with a concrete + * product artifact. + * + * @param target + * @param context + * @return + */ @Override public Document advance(Document target, CallContext context) { log.debug("SelectProductArtifact.advance()"); @@ -228,6 +286,14 @@ } + /** + * Create a describe document including the user interface description. The + * user gets the choice to select a product supported by the current fis. + * + * @param data + * @param context + * @return + */ @Override public Document describe(Document data, CallContext context) { log.debug("SelectProductArtifact.describe()"); @@ -293,6 +359,13 @@ } + /** + * + * @param document + * @param out + * @param context + * @throws IOException + */ @Override public void out(Document document, OutputStream out, CallContext context) throws IOException @@ -304,6 +377,13 @@ } + /** + * Append products to the describe document. + * + * @param document + * @param parent + * @param context + */ protected void appendProducts( Document document, Node parent, @@ -329,6 +409,14 @@ } + /** + * Append the product select box to the user interface description of the + * describe document. + * + * @param document + * @param node + * @param callMeta + */ protected void appendSelectProducts( Document document, Node node, @@ -379,6 +467,13 @@ } + /** + * Create a feed document. + * + * @param uuid + * @param hash + * @return + */ protected Document feedDocument(String uuid, String hash) { Document document = XMLUtils.newDocument(); @@ -421,4 +516,4 @@ return document; } } -// 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 : diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java Wed Mar 31 10:52:34 2010 +0000 @@ -5,6 +5,8 @@ import java.util.Collection; /** + * This is the default implementation of Product. + * * @author Tim Englich * */ @@ -24,9 +26,9 @@ /** * Constructor * - * @param name - * @param parameter - * @param artifactFactory + * @param name The name of this product. + * @param parameter Required parameters for this product. + * @param artifactFactory The artifact factory. */ public DefaultProduct( String name, @@ -40,24 +42,25 @@ } /** - * @see de.intevation.gnv.artifacts.fis.product.Product#getName() + * @return */ public String getName() { return this.name; } /** - * @see de.intevation.gnv.artifacts.fis.product.Product#getParameter() + * @return */ public Collection getParameter() { return this.parameter; } /** - * @see de.intevation.gnv.artifacts.fis.product.Product#getArtifactFactory() + * @return */ public String getArtifactFactory() { return this.artifactFactory; } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java Wed Mar 31 10:52:34 2010 +0000 @@ -7,14 +7,34 @@ import java.util.Collection; /** + * This is the interface description of Product. Currently, there + * are three methods defined:
+ *
    + *
  1. getName(): retrieves the name of the Product
    2. + *
  2. getParameter(): retrieves a collection of required parameters.
    3. + *
  3. getArtifactFactory(): retrieves the factory used to create this artifact. + *
    4. + *
* @author Tim Englich - * */ public interface Product extends Serializable { + /** + * + * @return The name of this product. + */ public String getName(); + /** + * + * @return All required parameters for parameterization. + */ public Collection getParameter(); + /** + * + * @return The artifact factory used to create the current artifact. + */ public String getArtifactFactory(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/ressource/RessourceFactory.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/ressource/RessourceFactory.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/ressource/RessourceFactory.java Wed Mar 31 10:52:34 2010 +0000 @@ -3,7 +3,6 @@ import de.intevation.artifacts.PreferredLocale; import java.io.BufferedReader; -import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; @@ -131,12 +130,9 @@ /** * Deliveres the translated Value for an Key to an given Language * - * @param locale - * The choosen locale - * @param key - * the key - * @param defaultValue - * the Value that should be returned. + * @param preferredLocales + * @param key the key + * @param defaultValue the Value that should be returned. * @return the translated Value */ public String getRessource(PreferredLocale[] preferredLocales, String key, @@ -149,6 +145,14 @@ } + /** + * Deliveres the language specific value for the given key + * + * @param locale + * @param key + * @param defaultVal + * @return language specific string. + */ public String getRessource(Locale locale, String key, String defaultVal) { if (key == null || locale == null) return defaultVal; @@ -167,3 +171,4 @@ } } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java Wed Mar 31 10:52:34 2010 +0000 @@ -93,9 +93,14 @@ } /** + * @param data + * @param globalContext + * @param callMeta + * @return * @see de.intevation.artifactdatabase.DefaultService#process(org.w3c.dom.Document, java.lang.Object, de.intevation.artifacts.CallMeta) */ @Override + @SuppressWarnings({"static-access", "static-access"}) public Document process(Document data, Object globalContext, CallMeta callMeta) { log.debug("MetaDataService.process"); @@ -107,10 +112,10 @@ this.getFIS(mapServices)); document = XMLUtils.newDocument(); this.writeFIS2Document(document, resultFIS); - log.debug(new ArtifactXMLUtilities().writeDocument2String(document)); + log.debug(ArtifactXMLUtilities.writeDocument2String(document)); } catch (MetaDataServiceException e) { log.error(e,e); - document = new ArtifactXMLUtilities() + document = ArtifactXMLUtilities .createExceptionReport(e.getMessage(), document); } return document; @@ -262,6 +267,7 @@ * Returns all FIS which Areas is intersected by this given Geometry * @param g the Geometry which should be used to determine the FIS. * @return all FIS which Areas is intersected by this given Geometry + * @throws MetaDataServiceException */ protected Collection getFIS(Geometry g) throws MetaDataServiceException{ @@ -296,6 +302,7 @@ * Returns all FIS which were represented by the given Mapservices * @param mapServices the Mapservices which should determine the FIS. * @return all FIS which where represented my the given Mapservices. + * @throws MetaDataServiceException */ protected Collection getFIS(Collection mapServices) throws MetaDataServiceException{ @@ -417,6 +424,7 @@ return null; } + @SuppressWarnings("empty-statement") private String createLayerQueryString(Collection layer){ log.debug("MetaDataService.createLayerQueryString"); StringBuffer sb = new StringBuffer();; @@ -443,6 +451,8 @@ } /** + * @param factory + * @param globalContext * @see de.intevation.artifactdatabase.DefaultService#setup(de.intevation.artifacts.ServiceFactory, java.lang.Object) */ @Override diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java Wed Mar 31 10:52:34 2010 +0000 @@ -44,3 +44,4 @@ } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java Wed Mar 31 10:52:34 2010 +0000 @@ -4,6 +4,8 @@ import java.util.Iterator; /** + * The default implementation of Fis. + * * @author Tim Englich * */ @@ -14,14 +16,19 @@ private Collection parameter = null; + /** + * Constructor + * + * @param id The id for this fis. + */ public DefaultFIS(String id){ super(); this.id = id; } /** * Constructor - * @param id - * @param parameter + * @param id The id for this fis. + * @param parameter A collection of parameters. */ public DefaultFIS(String id, Collection parameter) { this(id); @@ -29,19 +36,25 @@ } /** - * @see de.intevation.gnv.artifacts.services.requestobjects.FIS#getID() + * @return the id. */ public String getID() { return this.id; } /** - * @see de.intevation.gnv.artifacts.services.requestobjects.FIS#getParameter() + * @return the parameter collection. */ public Collection getParameter() { return this.parameter; } + /** + * Two objects are equal if they have the same id. + * + * @param arg0 Object which is checked for equality. + * @return True, if both objects are equal, otherwise false. + */ @Override public boolean equals(Object arg0) { boolean returnValue = false; @@ -50,8 +63,21 @@ } return returnValue; } + /** - * @see de.intevation.gnv.artifacts.services.requestobjects.FIS#addParameter(java.util.Collection) + * Creates a hash code using the id and the given parameters. + * + * @return A hash code. + */ + @Override + public int hashCode() { + int hash = 7; + hash = 47 * hash + (this.id != null ? this.id.hashCode() : 0); + hash = 47 * hash + (this.parameter != null ? this.parameter.hashCode() : 0); + return hash; + } + /** + * @param parameter Collection of parameters. */ public void addParameter(Collection parameter) { if (this.parameter != null){ @@ -70,3 +96,4 @@ } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Wed Mar 31 10:52:34 2010 +0000 @@ -1,6 +1,8 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** + * The default implementation of Layer. + * * @author Tim Englich * */ @@ -14,8 +16,13 @@ private boolean groupLayer = false; private String parentId = null; + /** * Constructor + * @param id The id of this layer. + * @param name The name of this layer. + * @param groupLayer A boolean property to define this layer as group layer. + * @param parentId The id of the parent layer. */ public DefaultLayer(String id,String name, boolean groupLayer,String parentId) { @@ -26,35 +33,39 @@ } - /** - * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#getID() + * @return */ public String getID() { return this.id; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#getName() + * @return */ public String getName() { return this.name; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#isGroupLayer() + * @return */ public boolean isGroupLayer() { return this.groupLayer; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#parentID() + * @return */ public String parentID() { return this.parentId; } + /** + * This methods returns this layer as string. + * + * @return this layer as string. + */ @Override public String toString() { return "ID: "+ this.id + " Name: "+this.name+ @@ -63,3 +74,4 @@ } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Wed Mar 31 10:52:34 2010 +0000 @@ -3,6 +3,8 @@ import java.util.Collection; /** + * The default implementation of MapService. + * * @author Tim Englich * */ @@ -10,15 +12,18 @@ private String id = null; - - private Collection layer = null; private String type = null; private String url = null; + /** * Constructor + * @param id The id of this service. + * @param type The type of this service. + * @param layer The layers available in this service. + * @param url The url used to call this service. */ public DefaultMapService(String id, Collection layer, String type, String url) { @@ -30,31 +35,32 @@ } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.MapService#getID() + * @return */ public String getID() { return this.id; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.MapService#getLayer() + * @return */ public Collection getLayer() { return this.layer; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.MapService#getType() + * @return */ public String getType() { return this.type; } /** - * @see de.intevation.gnv.artifactdatabase.objects.map.MapService#getURL() + * @return */ public String getURL() { return this.url; } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Wed Mar 31 10:52:34 2010 +0000 @@ -1,8 +1,9 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** + * The default implementation of Parameter. + * * @author Tim Englich - * */ public class DefaultParameter implements Parameter { @@ -13,8 +14,8 @@ /** * Constructor - * @param id - * @param name + * @param id The id of this parameter. + * @param name The name of this parameter. */ public DefaultParameter(String id, String name) { super(); @@ -23,17 +24,18 @@ } /** - * @see de.intevation.gnv.artifacts.services.requestobjects.Parameter#getID() + * @return */ public String getID() { return this.id; } /** - * @see de.intevation.gnv.artifacts.services.requestobjects.Parameter#getName() + * @return */ public String getName() { return this.name; } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Wed Mar 31 10:52:34 2010 +0000 @@ -3,13 +3,38 @@ import java.util.Collection; /** + * This is the interface description for a fis. Currently, there are three + * methods defined which need to be implemented by concrete classes:
+ *
    + *
  1. getID(): Returns the id of this fis.
    2. + *
  2. getParameter(): Returns a collection of parameter.
    3. + *
  3. addParameter(Collection): Adds a parameter collection to this + * fis.
    4. + *
+ * * @author Tim Englich * */ public interface FIS { + /** + * + * @return the id of this fis. + */ String getID(); + + /** + * + * @return a collection of parameters. + */ Collection getParameter(); + + /** + * Add a collection of parameters to this fis. + * + * @param parameter Some parameters. + */ void addParameter(Collection parameter); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java Wed Mar 31 10:52:34 2010 +0000 @@ -1,14 +1,43 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** + * This is the inteface description of a Layer. Currently, there + * are four methods defined here:
+ *
    + *
  1. getName(): Returns the name of this layer.
    2. + *
  2. getID(): Returns the id of this layer.
    3. + *
  3. isGroupLayer(): Returns true, if this layer contains child layers.
    4. + *
  4. parentID(): Returns the id of the parent layer if this layer is a + * group layer.
    5. + *
+ * * @author Tim Englich * */ public interface Layer { + /** + * + * @return the name of this layer. + */ String getName(); + + /** + * + * @return the id of this layer. + */ String getID(); + + /** + * + * @return true, if this layer is a group layer - otherwise false. + */ boolean isGroupLayer(); + + /** + * + * @return the id of the parent. + */ String parentID(); - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java Wed Mar 31 10:52:34 2010 +0000 @@ -3,18 +3,45 @@ import java.util.Collection; /** + * This is the interface description of MapService. Currently, + * there are four methods defined:
+ *
    + *
  1. getID(): Returns the id of this service.
    2. + *
  2. getURL(): Returns the url used to call this service.
    3. + *
  3. getType(): Returns the service type.
    4. + *
  4. getLayer(): Returns a collection of layers contained in this service. + *
    5. + *
+ * * @author Tim Englich * */ public interface MapService { + /** + * + * @return the id of this service. + */ String getID(); + /** + * + * @return the url under which this service is available. + */ String getURL(); + /** + * + * @return the service type. + */ String getType(); + /** + * + * @return a collection of layers contained in this service. + */ Collection getLayer(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 23877dd69444 -r 9b9bf42b7928 gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Wed Mar 31 10:52:34 2010 +0000 @@ -1,12 +1,27 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** + * This is the interface description of Parameter. Currently, there + * are two methods defined:
+ *
    + *
  1. getName(): Returns the name of this parameter.
    2. + *
  2. getID(): Returns the id of this parameter.
    3. + *
+ * * @author Tim Englich - * */ public interface Parameter { + /** + * + * @return the name of this parameter. + */ String getName(); - String getID (); + /** + * + * @return the id of this parameter. + */ + String getID(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file