GeoServer hidden treasures: filter functions

Ever had the need to format some text in SLD, or to perform complex filter in WFS, and noticed that the basic elements of the OGC Filter specification left you wanting for more?

If so, welcome to the club. One thing few people know is that both SLD and WFS filtering capabilities can be extended by using filter functions. A filter function is just like a programming language function, it’s something that takes arguments and returns some result. For example, “sin(toRadians(45))” will compute the mathematical sin of 45 degrees, and “strSubstring(“hippopotamus”, 0,  5)” will return “hippo”.

The concept of filter function is standardized, but functions themselves are not, so once you start using them you’re tied to a specific server. However they often provide the level of flexibility that you just need in order to get some work done. The good news is that GeoServer already contains tens of them, from number and date formatting, to geometry manipulation, math, string wrangling. So far we just never found the time to document them, but things have changed and we have now quite a complete reference along with some examples.

Let me show you a simple example of using functions. Say we have a contour map, each isoline has an elevation, and we want to show it on the map. Unfortunately the elevation is stored as a floating point, resulting in a less than pleasing output of “150.0″ or sometimes “149.999999″ when we know the elevation accuracy does not go beyond the meter. To get nice labelling we can use the “numberFormat” filter function to force an integer representation instead (along with some VendorOptions):

<TextSymbolizer>
  <Label>
    <ogc:Function name="numberFormat">
       <ogc:Literal>#</ogc:Literal>
       <ogc:PropertyName>ELEVATION</ogc:PropertyName>
    </ogc:Function>
   </Label>
  ....
   <VendorOption name="followLine">true</VendorOption>
   <VendorOption name="repeat">250</VendorOption>
   <VendorOption name="maxDisplacement">150</VendorOption>
   <VendorOption name="maxAngleDelta">30</VendorOption>
</TextSymbolizer>

Notice how the the ELEVATION field is formatted as an integer number following the simple formatting pattern provided (for a full reference see the the Java DecimalFormat documentation):

contours

I hope you’ll find interesting and clever uses of the existing filter functions to improve the way you work with GeoServer. Next time I’ll show you my favourite one, which is also a new feature in GeoServer 2.0.1, called “geometry transformations”. Stay tuned to learn more about it.

One Comment

  1. Posted 2010/02/09 at 9:45 am | Permalink

    Thanks, Andrea! I’d been hoping for more documentation on filter functions. I’m going to put this example to use right now with our contours, and try to work up some other examples.

Download GeoServer