openlayers/lib/OpenLayers/Filter.js

   1 /* Copyright (c) 2006 MetaCarta, Inc., published under a modified BSD license.
   2  * See http://svn.openlayers.org/trunk/openlayers/repository-license.txt
   3  * for the full text of the license. */
   4
   5
   6 /**
   7  * @requires OpenLayers/Util.js
   8  * @requires OpenLayers/Style.js
   9  */
  10
  11 /**
  12  * Class: OpenLayers.Filter
  13  * This class represents an OGC Filter.
  14  */
  15 OpenLayers.Filter = OpenLayers.Class({
  16
  17     /**
  18      * Constructor: OpenLayers.Filter
  19      * This is an abstract class.  Create an instance of a filter subclass.
  20      *
  21      * Parameters:
  22      * options - {Object} Optional object whose properties will be set on the
  23      *     instance.
  24      *
  25      * Returns:
  26      * {<OpenLayers.Filter>}
  27      */
  28     initialize: function(options) {
  29         OpenLayers.Util.extend(this, options);
  30     },
  31
  32     /**
  33      * APIMethod: destroy
  34      * Remove reference to anything added.
  35      */
  36     destroy: function() {
  37     },
  38
  39     /**
  40      * APIMethod: evaluate
  41      * Evaluates this filter in a specific context.  Should be implemented by
  42      *     subclasses.
  43      *
  44      * Parameters:
  45      * context - {Object} Context to use in evaluating the filter.
  46      *
  47      * Returns:
  48      * {Boolean} The filter applies.
  49      */
  50     evaluate: function(context) {
  51         return true;
  52     },
  53
  54     /**
  55      * APIMethod: clone
  56      * Clones this filter. Should be implementted by subclasses.
  57      *
  58      * Returns:
  59      * {<OpenLayers.Filter>} Clone of this filter.
  60      */
  61     clone: function() {
  62         return null;
  63     },
  64
  65     CLASS_NAME: "OpenLayers.Filter"
  66 });