Mercurial > dive4elements > gnv-client
changeset 826:32d01e1ce2df
Added more JavaDocs
gnv-artifacts/trunk@920 c6561f87-3c4e-4783-a992-168aeb5c3f6f
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/ChangeLog Tue Apr 13 12:32:24 2010 +0000 @@ -1,3 +1,16 @@ +2010-04-13 Tim Englich <tim.englich@intevation.de> + + * src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.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/FIS.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/services/requestobjects/Parameter.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/package.html: + Added more Javadoc. + 2010-04-13 Tim Englich <tim.englich@intevation.de> * src/main/java/de/intevation/gnv/transition/package.html,
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultFIS.java Tue Apr 13 12:32:24 2010 +0000 @@ -11,9 +11,14 @@ */ public class DefaultFIS implements FIS { - + /** + * The ID of the FIS + */ private String id = null; + /** + * The Parameter which belongs to the FIS. + */ private Collection<Parameter> parameter = null; /** @@ -35,16 +40,11 @@ this.parameter = parameter; } - /** - * @return the id. - */ + public String getID() { return this.id; } - /** - * @return the parameter collection. - */ public Collection<Parameter> getParameter() { return this.parameter; } @@ -76,6 +76,7 @@ hash = 47 * hash + (this.parameter != null ? this.parameter.hashCode() : 0); return hash; } + /** * @param parameter Collection of parameters. */ @@ -92,8 +93,5 @@ this.parameter = parameter; } } - - - } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Tue Apr 13 12:32:24 2010 +0000 @@ -1,20 +1,31 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** - * The default implementation of <code>Layer</code>. + * The default Implementation of <code>Layer</code>. * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * */ public class DefaultLayer implements Layer { - + /** + * The id of the Layer + */ private String id = null; + /** + * The name of the Layer + */ private String name = null; + /** + * Flag which defines if the Layer is a GroupLayer + */ private boolean groupLayer = false; + /** + * The ID of the Parentlayer or null if the Layer is a Rootlayer + */ private String parentId = null; /** @@ -32,31 +43,18 @@ this.parentId = parentId; } - - /** - * @return the id. - */ public String getID() { return this.id; } - /** - * @return the name. - */ public String getName() { return this.name; } - /** - * @return true, if this is a group layer. - */ public boolean isGroupLayer() { return this.groupLayer; } - /** - * @return the parent id. - */ public String parentID() { return this.parentId; }
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Tue Apr 13 12:32:24 2010 +0000 @@ -3,19 +3,31 @@ import java.util.Collection; /** - * The default implementation of <code>MapService</code>. + * The default Implementation of <code>MapService</code>. * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * */ public class DefaultMapService implements MapService { + /** + * The id of the Mapservice + */ private String id = null; + /** + * The Layer which belongs to the Mapservice + */ private Collection<Layer> layer = null; + /** + * The Type of the Mapservice + */ private String type = null; + /** + * The Url under which the Mapservice could be accessed. + */ private String url = null; /**
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Tue Apr 13 12:32:24 2010 +0000 @@ -1,15 +1,21 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** - * The default implementation of <code>Parameter</code>. + * The default Implementation of <code>Parameter</code>. * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> */ public class DefaultParameter implements Parameter { + /** + * The id of the Parameter + */ private String id = null; + /** + * The name of the Parameter + */ private String name = null; /**
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Tue Apr 13 12:32:24 2010 +0000 @@ -18,13 +18,13 @@ public interface FIS { /** - * + * Returns the id of this FIS * @return the id of this fis. */ String getID(); /** - * + * Returns a collection of Parameters which belongs to the FIS. * @return a collection of parameters. */ Collection<Parameter> getParameter();
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java Tue Apr 13 12:32:24 2010 +0000 @@ -17,25 +17,27 @@ public interface Layer { /** - * + * Returns the name of this layer. * @return the name of this layer. */ String getName(); /** - * + * Returns the id of this layer. * @return the id of this layer. */ String getID(); /** - * + * Returns true if the Layer is an GroupLayer * @return true, if this layer is a group layer - otherwise false. */ boolean isGroupLayer(); /** - * + * Returned the ID of the Parent Layer. + * Only if the Layer is a Child-Layer. + * If this Layer is an Root-Layer null will be returned. * @return the id of the parent. */ String parentID();
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java Tue Apr 13 12:32:24 2010 +0000 @@ -20,25 +20,25 @@ /** - * + * Returns the id of this Service. * @return the id of this service. */ String getID(); /** - * + * Returns the Url under which this service is available. * @return the url under which this service is available. */ String getURL(); /** - * + * Returns the service type * @return the service type. */ String getType(); /** - * + * Returns the Layer which belongs to this Service. * @return a collection of layers contained in this service. */ Collection<Layer> getLayer();
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Tue Apr 13 12:32:24 2010 +0000 @@ -13,12 +13,12 @@ public interface Parameter { /** - * + * The Name of this Parameter * @return the name of this parameter. */ String getName(); /** - * + * The ID of this Parameter * @return the id of this parameter. */ String getID();
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/package.html Tue Apr 13 08:50:08 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/package.html Tue Apr 13 12:32:24 2010 +0000 @@ -3,6 +3,8 @@ <head> </head> <body> -DOCUMENT ME! +This package provides Interfaces and Classes which are required to represent the +Objects which are required to handle all Servicerequests which are defined in the +Parentpackage. </body> </html>