Mercurial > mxd2map > mxd2map
diff src/java/de/intevation/mxd/reader/LineSymbolReader.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/LineSymbolReader.java Mon Jul 11 12:11:08 2011 +0200 +++ b/src/java/de/intevation/mxd/reader/LineSymbolReader.java Mon Jul 11 14:28:38 2011 +0200 @@ -29,27 +29,51 @@ private static final Logger logger = Logger.getLogger(LineSymbolReader.class); + /** + * Private member. + */ private ISymbol symbol; private ILineSymbol lineSymbol; - public LineSymbolReader() throws Exception{ + /** + * Default constructor. + */ + public LineSymbolReader() + throws Exception{ logger.debug("contructor()"); this.symbol = null; this.lineSymbol = null; } - public LineSymbolReader(ISymbol symbol) throws Exception{ + /** + * Constructor with symbol. + * + * @param symbol The symbol used to display lines. + */ + public LineSymbolReader(ISymbol symbol) + throws Exception { logger.debug("contructor(ISymbol)"); this.symbol = symbol; this.lineSymbol = null; } - public LineSymbolReader(ILineSymbol symbol) throws Exception{ + /** + * Constructor with symbol. + * + * @param symbol The symbol used to display lines. + */ + public LineSymbolReader(ILineSymbol symbol) + throws Exception{ logger.debug("contructor(ILineSymbol)"); this.lineSymbol = symbol; this.symbol= null; } + /** + * Read the symbo attributes. + * + * @return DOM element containing the symbol attributes. + */ public Element read() { ISymbolReader sreader = null; if(symbol != null) { @@ -131,16 +155,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.lineSymbol = null; } + /** + * Sets the symbol to read. + * + * @param sym The symbol used to display points. + */ public void setSymbol(ILineSymbol sym) { this.lineSymbol = 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 SimpleLineSymbol || sym instanceof MarkerLineSymbol || @@ -155,6 +194,11 @@ } } + /** + * Determine whether this reader can be used to read the symbol. + * + * @param sym The ArcGIS symbol. + */ public boolean canRead(ILineSymbol sym) { if(sym instanceof SimpleLineSymbol || sym instanceof MarkerLineSymbol ||