dwins#32, Add support for graphic-margin vendor option, and dwins#20, Support 'labelObstacle' vendor parameter in CSS

Author: aaime

geocss/src/main/scala/org/geoscript/geocss/Translator.scala

@@ -34,7 +34,7 @@ class Translator(val baseURL: Option[java.net.URL]) {
   val styles = org.geotools.factory.CommonFactoryFinder.getStyleFactory()
   type OGCExpression = org.opengis.filter.expression.Expression
 
-  val gtVendorOpts = Seq(
+  val gtTextVendorOpts = Seq(
     "-gt-label-padding" -> "spaceAround",
     "-gt-label-group" -> "group",
     "-gt-label-max-displacement" -> "maxDisplacement",
@@ -52,6 +52,19 @@ class Translator(val baseURL: Option[java.net.URL]) {
     "-gt-shield-resize" -> "graphic-resize",
     "-gt-shield-margin" -> "graphic-margin"
   )
+  
+  val gtPolygonVendorOpts = Seq(
+    "-gt-graphic-margin" -> "graphic-margin",
+    "-gt-fill-label-obstacle" -> "labelObstacle"
+  )
+  
+  val gtPointVendorOpts = Seq(
+    "-gt-mark-label-obstacle" -> "labelObstacle"
+  )
+  
+  val gtLineVendorOpts = Seq(
+     "-gt-stroke-label-obstacle" -> "labelObstacle"
+  )
 
   private val defaultRGB = filters.literal(colors("grey"))
 
@@ -409,6 +422,22 @@ class Translator(val baseURL: Option[java.net.URL]) {
 
     def orderedMarkRules(symbolizerType: String, order: Int): Seq[Property] =
       rule.context(symbolizerType, order)
+      
+    /**
+     * Applies the specified vendor options to the symbolizer, taking them from the collected properties values
+     */
+    def applyVendorOptions(sym: Symbolizer, props : Map[String, Seq[Value]], vendorOptions : Seq[(String, String)]) : Unit = {
+       for (
+          (cssName, sldName) <- vendorOptions;
+          value <- props.get(cssName)
+        ) {
+          sym.getOptions().put(
+            sldName,
+            value.collect({ case Literal(x) => x }).mkString(" ")
+          )
+        }
+
+    }
 
     val lineSyms: Seq[(Double, LineSymbolizer)] = 
       (expand(properties, "stroke").toStream zip
@@ -452,6 +481,10 @@ class Translator(val baseURL: Option[java.net.URL]) {
             null
           )
         geom.foreach { sym.setGeometry }
+        
+        // collect the vendor options for line symbolizers
+        applyVendorOptions(sym, props, gtLineVendorOpts)
+        
         (zIndex, sym)
       }
 
@@ -481,6 +514,10 @@ class Translator(val baseURL: Option[java.net.URL]) {
           null
         )
         geom.foreach { sym.setGeometry(_) }
+        
+        // collect the vendor options for polygon symbolizers
+        applyVendorOptions(sym, props, gtPolygonVendorOpts)
+        
         (zIndex, sym)
       }
 
@@ -498,6 +535,10 @@ class Translator(val baseURL: Option[java.net.URL]) {
         for (g <- graphic) yield {
           val sym = styles.createPointSymbolizer(g, null)
           geom.foreach { sym.setGeometry(_) }
+          
+          // collect the vendor options for point symbolizers
+          applyVendorOptions(sym, props, gtPointVendorOpts)
+          
           (zIndex, sym)
         }
       }
@@ -620,15 +661,8 @@ class Translator(val baseURL: Option[java.net.URL]) {
           sym.setPriority(priority)
         }
 
-        for (
-          (cssName, sldName) <- gtVendorOpts;
-          value <- props.get(cssName)
-        ) {
-          sym.getOptions().put(
-            sldName,
-            value.collect({ case Literal(x) => x }).mkString(" ")
-          )
-        }
+        // collect the vendor options for text symbolizers
+        applyVendorOptions(sym, props, gtTextVendorOpts)
 
         (zIndex, sym)
       }

geocss/src/test/resources/gt-line-opts.css

@@ -0,0 +1,7 @@
+/**
+ * Example usage of GeoTools-specific extension properties
+ */
+* {
+  stroke: red;
+  -gt-stroke-label-obstacle: true;
+}

geocss/src/test/resources/gt-point-opts.css

@@ -0,0 +1,8 @@
+/**
+ * Example usage of GeoTools-specific extension properties
+ */
+* {
+  mark: symbol("cicle");
+  mark-size: 10;
+  -gt-mark-label-obstacle: true;
+}

geocss/src/test/resources/gt-poly-opts.css

@@ -0,0 +1,8 @@
+/**
+ * Example usage of GeoTools-specific extension properties
+ */
+* {
+  fill: red;
+  -gt-fill-label-obstacle: true;
+  -gt-graphic-margin: 10 20 40 30;
+}

geocss/src/test/resources/gt-opts.css renamed to geocss/src/test/resources/gt-text-opts.css

@@ -151,23 +151,27 @@ class SLDTest extends FunSuite with ShouldMatchers {
     haloparams(0).text.trim should equal ("#FFFFFF")
     haloparams(1).text.trim.toDouble should be(closeTo(0.7, 0.001))
   }
-
-  test("GeoTools vendor options should be passed through") {
-    val vendorOptions = css2sld2dom("/gt-opts.css")
-
-    def vendor(name: String): Option[String] = {
-      (vendorOptions \\ "VendorOption") find {
-        _.attribute("name") map (_.text == name) getOrElse(false)
-      } map { 
-        _.child.text 
-      }
+  
+  /**
+   * Extracts the specified vendor option from the xml node
+   */
+  def getVendorOption(xml: scala.xml.Elem) (name: String): Option[String] = {
+    (xml \\ "VendorOption") find {
+      _.attribute("name") map (_.text == name) getOrElse(false)
+    } map { 
+      _.child.text 
     }
+  }
+
+  test("GeoTools text vendor options should be passed through") {
+    val vendorOptions = css2sld2dom("/gt-text-opts.css")
 
     // all vendor options should be direct children of textsymbolizers now
     vendorOptions \\ "VendorOption" should equal (
       vendorOptions \\ "TextSymbolizer" \ "VendorOption"
     )
-
+    
+    val vendor = getVendorOption(vendorOptions)_;
     vendor("allGroup") should be(Some("false"))
     vendor("maxAngleDelta") should be(Some("22.5"))
     vendor("followLine") should be(Some("false"))
@@ -186,6 +190,44 @@ class SLDTest extends FunSuite with ShouldMatchers {
 
     (vendorOptions \\ "Priority" \ "PropertyName").text should equal ("priority")
   }
+  
+  test("GeoTools polygon vendor options should be passed through") {
+    val vendorOptions = css2sld2dom("/gt-poly-opts.css")
+
+    // all vendor options should be direct children of polygon symbolizer now
+    vendorOptions \\ "VendorOption" should equal (
+      vendorOptions \\ "PolygonSymbolizer" \ "VendorOption"
+    )
+
+    val vendor = getVendorOption(vendorOptions)_;
+    vendor("labelObstacle") should be(Some("true"))
+    vendor("graphic-margin") should be(Some("10 20 40 30"))
+  }
+  
+  test("GeoTools point vendor options should be passed through") {
+    val vendorOptions = css2sld2dom("/gt-point-opts.css")
+
+    // all vendor options should be direct children of point symbolizer now
+    vendorOptions \\ "VendorOption" should equal (
+      vendorOptions \\ "PointSymbolizer" \ "VendorOption"
+    )
+
+    val vendor = getVendorOption(vendorOptions)_;
+    vendor("labelObstacle") should be(Some("true"))
+  }
+  
+  test("GeoTools line vendor options should be passed through") {
+    val vendorOptions = css2sld2dom("/gt-line-opts.css")
+
+    // all vendor options should be direct children of line symbolizer now
+    vendorOptions \\ "VendorOption" should equal (
+      vendorOptions \\ "LineSymbolizer" \ "VendorOption"
+    )
+
+    val vendor = getVendorOption(vendorOptions)_;
+    vendor("labelObstacle") should be(Some("true"))
+  }
+
 
 
   test("Mixing selector properties doensn't produce empty rules") {