diff src/java/de/intevation/mxd/reader/MarkerSymbolReader.java @ 181:0bde090506f9

Added comments.
author Raimund Renkert <rrenkert@intevation.de>
date Mon, 11 Jul 2011 14:28:38 +0200
parents f4eb506499f5
children df4e0946ef02
line wrap: on
line diff
--- a/src/java/de/intevation/mxd/reader/MarkerSymbolReader.java	Mon Jul 11 12:11:08 2011 +0200
+++ b/src/java/de/intevation/mxd/reader/MarkerSymbolReader.java	Mon Jul 11 14:28:38 2011 +0200
@@ -28,9 +28,17 @@
     private static final Logger logger =
         Logger.getLogger(MarkerSymbolReader.class);
 
+    /**
+     * Private member.
+     */
     private ISymbol symbol;
     private IMarkerSymbol markerSymbol;
 
+    /**
+     * Constructor with symbol.
+     *
+     * @param symbol The symbol used to display points.
+     */
     public MarkerSymbolReader(ISymbol symbol)
     throws Exception {
         logger.debug("contructor(ISymbol)");
@@ -38,6 +46,11 @@
         this.markerSymbol = null;
     }
 
+    /**
+     * Constructor with symbol.
+     *
+     * @param symbol The symbol used to display points.
+     */
     public MarkerSymbolReader(IMarkerSymbol symbol)
     throws Exception {
         logger.debug("contructor(ISymbol)");
@@ -45,12 +58,20 @@
         this.symbol = null;
     }
 
+    /**
+     * Default constructor.
+     */
     public MarkerSymbolReader() {
         logger.debug("contructor()");
         this.symbol = null;
         this.markerSymbol = null;
     }
 
+    /**
+     * Reads the symbol attributes.
+     *
+     * @return The DOM element containing the attributes.
+     */
     public Element read() {
         logger.debug("read()");
         ISymbolReader sreader = null;
@@ -127,16 +148,31 @@
         return parent;
     }
 
+    /**
+     * Sets the symbol to read.
+     *
+     * @param sym The symbol used to display points.
+     */
     public void setSymbol(ISymbol sym) {
         this.symbol = sym;
         this.markerSymbol = null;
     }
 
+    /**
+     * Sets the symbol to read.
+     *
+     * @param sym The symbol used to display points.
+     */
     public void setSymbol(IMarkerSymbol sym) {
         this.markerSymbol = sym;
         this.symbol = null;
     }
 
+    /**
+     * Determine whether this reader can be used to read the symbol.
+     *
+     * @param sym The ArcGIS symbol.
+     */
     public boolean canRead(ISymbol sym) {
         if(sym instanceof SimpleMarkerSymbol ||
            sym instanceof ArrowMarkerSymbol ||
@@ -150,6 +186,11 @@
         }
     }
 
+    /**
+     * Determine whether this reader can be used to read the symbol.
+     *
+     * @param sym The ArcGIS symbol.
+     */
     public boolean canRead(IMarkerSymbol sym) {
         if(sym instanceof SimpleMarkerSymbol ||
            sym instanceof ArrowMarkerSymbol ||
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)