Community Mapbuilder

Refactor parsing of widget/tool/model config properties into a convenience method

Details

  • Type: Task Task
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.5rc2
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

Currently, every widget, tool and model script picks its config properties by using something like

var propertyNode = widgetNode.selectSingleNode("mb:myProperty");
this.property = propertyNode ? propertyNode.firstChild.nodeValue() : "default";

Not only that firstChild.nodeValue does not work in Opera (this is the reason why there is now the getNodeValue in Util.js, which is not being used very frequently), but it produces quite a huge amount of code duplication.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Andreas Hocevar added a comment - - edited

in r3866: introduced new functions Mapbuilder.getProperty() and Mapbuilder.parseBoolean(). MapPaneOL already makes use of those.

Instead of the above, we can now say

this.property = Mapbuilder.getProperty(widgetNode, "mb:property", "default");

If we expect "true" or "false" in a config node, we can parse it to a boolean value simply by saying:

this.property = Mapbuilder.parseBoolean(
Mapbuilder.getProperty(widgetNode, "mb:boolProp", "true"));

TODO: use it in all widgets, tools and models.

Show
Andreas Hocevar added a comment - - edited in r3866: introduced new functions Mapbuilder.getProperty() and Mapbuilder.parseBoolean(). MapPaneOL already makes use of those. Instead of the above, we can now say this.property = Mapbuilder.getProperty(widgetNode, "mb:property", "default"); If we expect "true" or "false" in a config node, we can parse it to a boolean value simply by saying: this.property = Mapbuilder.parseBoolean( Mapbuilder.getProperty(widgetNode, "mb:boolProp", "true")); TODO: use it in all widgets, tools and models.
Hide
Permalink
Gertjan van Oosten added a comment -

Done this for widgets, tools, models, examples and util.
Also used getNodeValue() and Mapbuilder.parseBoolean() where appropriate.

In lib/model/, there's four places left that use .firstChild.nodeValue, but they use it as an LHS there and I don't know what it should be turned into.

Furthermore, in lib/util/openlayers/OpenLayers.js, there's a lot of places it is being used. I guess these should be fixed in OL.

Lastly, I didn't touch the contextEditor and catalog examples, so these still use the old idiom.

Show
Gertjan van Oosten added a comment - Done this for widgets, tools, models, examples and util. Also used getNodeValue() and Mapbuilder.parseBoolean() where appropriate. In lib/model/, there's four places left that use .firstChild.nodeValue, but they use it as an LHS there and I don't know what it should be turned into. Furthermore, in lib/util/openlayers/OpenLayers.js, there's a lot of places it is being used. I guess these should be fixed in OL. Lastly, I didn't touch the contextEditor and catalog examples, so these still use the old idiom.

People

  • Assignee:
    Unassigned
    Reporter:
    Andreas Hocevar
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: