Mercurial > mxd2map
diff src/java/de/intevation/mxd/reader/FillSymbolReader.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/FillSymbolReader.java Mon Jul 11 12:11:08 2011 +0200 +++ b/src/java/de/intevation/mxd/reader/FillSymbolReader.java Mon Jul 11 14:28:38 2011 +0200 @@ -27,27 +27,51 @@ private static final Logger logger = Logger.getLogger(FillSymbolReader.class); + /** + * Private member. + */ private ISymbol symbol; private IFillSymbol fillSymbol; - public FillSymbolReader() throws Exception{ + /** + * Default constructor. + */ + public FillSymbolReader() + throws Exception { logger.debug("contructor()"); this.symbol = null; this.fillSymbol = null; } - public FillSymbolReader(ISymbol symbol) throws Exception{ + /** + * Constructor with symbol. + * + * @param symbol The symbol used to display polygons. + */ + public FillSymbolReader(ISymbol symbol) + throws Exception { logger.debug("contructor(ISymbol)"); this.symbol = symbol; this.fillSymbol = null; } - public FillSymbolReader(IFillSymbol symbol) throws Exception{ + /** + * Constructor with symbol. + * + * @param symbol The symbol used to display polygons. + */ + public FillSymbolReader(IFillSymbol symbol) + throws Exception { logger.debug("contructor(ILineSymbol)"); this.fillSymbol = symbol; this.symbol= null; } + /** + * Read the symbol attributes. + * + * @return DOM element containing the symbol attributes. + */ public Element read() { ISymbolReader sreader = null; if(symbol != null) { @@ -117,16 +141,31 @@ return parent; } + /** + * Sets the symbol to read. + * + * @param the symbol used to display polygons. + */ public void setSymbol(ISymbol sym) { this.symbol = sym; this.fillSymbol = null; } + /** + * Sets the symbol to read. + * + * @param the symbol used to display polygons. + */ public void setSymbol(IFillSymbol sym) { this.symbol = null; this.fillSymbol = sym; } + /** + * Determine whether this reader can be used to read the symbol. + * + * @param sym The ArcGIS symbol. + */ public boolean canRead(ISymbol sym) { if(sym instanceof SimpleFillSymbol || sym instanceof MarkerFillSymbol || @@ -139,6 +178,11 @@ } } + /** + * Determine whether this reader can be used to read the symbol. + * + * @param sym The ArcGIS symbol. + */ public boolean canRead(IFillSymbol sym) { if(sym instanceof SimpleFillSymbol || sym instanceof MarkerFillSymbol || @@ -150,6 +194,5 @@ return false; } } - } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :