Mercurial > dive4elements > gnv-client
diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/map/Layer.java @ 690:254f062e334b
Added JavaDoc.
gnv/trunk@908 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Mon, 12 Apr 2010 16:45:16 +0000 |
parents | 57fa8019fbdc |
children | af22fa5567a6 |
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/map/Layer.java Mon Apr 12 10:56:55 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/map/Layer.java Mon Apr 12 16:45:16 2010 +0000 @@ -1,14 +1,39 @@ package de.intevation.gnv.artifactdatabase.objects.map; /** + * This interface defines some basic methods providing information about a map + * layer. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface Layer { + /** + * Retrieves the name of a layer. + * + * @return the name of a layer. + */ String getName(); + + /** + * Retrieves the id of a layer. + * + * @return the id of a layer. + */ String getID(); + + /** + * Retrieves true, if this layer is a group layer - otherwise false. + * + * @return true, if this layer is a group layer - otherwise false. + */ boolean isGroupLayer(); + + /** + * Retrieves the id of the parent layer. + * + * @return the id of the parent layer. + */ String parentID(); - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file