Property Detail

• static Filter FAIL

  The FAIL Filter wrapps the GeoTools EXCLUDE Filter

• static Filter PASS

  The PASS Filter wrapps the Geotools INCLUDE Filter

• FilterFactory2 factory

  The GeoTools FilterFactory

• Filter filter

  The wrapped GeoTools Filter

Constructor Detail

• Filter(Filter filter)

  Create a new Filter wrapping a GeoTools Filter

  Parameters:

  filter - The org.opengis.filter.Filter

• Filter(Filter filter)

  Create a new Filter from an existing Filter

  Parameters:

  filter - The exiting Filter

• Filter(java.lang.String str)

  Create a new Filter from a String (CQL or XML).

  Parameters:

  str - The String CQL or XML

  Creating a Filter with CQL:

  Filter f = new Filter("name='foobar')

  Creating a Filter with XML:

  Filter f = new Filter('<Filter><PropertyIsEqualTo><PropertyName>name</PropertyName><Literal>foobar</Literal></PropertyIsEqualTo></Filter>')

Method Detail

• Filter and(java.lang.Object other)

  Combine the current Filter with another Filter.

  Parameters:

  other - Another Filter or a CQL String

  Returns:

  A combined Filter

• static Filter bbox(java.lang.String fieldName, Bounds bounds)

  Create a Spatial Bounding Box Filter

  Parameters:

  fieldName - The geometry field name (defaults to the_geom)

  bounds - The Bounds

  Returns:

  A Filter

• static Filter contains(java.lang.String fieldName, Geometry geometry)

  Create a Spatial Filter that contains the given Geometry

  Parameters:

  fieldName - The geometry field name (defaults to the_geom)

  geometry - The Geometry

  Returns:

  A Filter

• static Filter crosses(java.lang.String fieldName, Geometry geometry)

  Create a Spatial Filter that crosses the given Geometry

  Parameters:

  fieldName - The geometry field name (defaults to the_geom)

  geometry - The Geometry

  Returns:

  A Filter

• static Filter dwithin(java.lang.String fieldName, Geometry geometry, double distance, java.lang.String units)

  Create a Spatial Filter that is within a certain distance of the given Geometry. There are some serious limitations to DWITHIN in Geotools. It does not work with projection EPSG:4326!

  Parameters:

  fieldName - The geometry field name (defaults to the_geom)

  geometry - The Geometry

  distance - The distance

  units - The units (kilometers, meters, feet, ect...)

  Returns:

  A Filter

• boolean equals(java.lang.Object obj)

  Does this Filter equal another Filter?

  Returns:

  Whether this and the other Filter are equal

• static Filter equals(java.lang.String field, java.lang.Object value)

  Create a Filter where a Property equals a Literal

  Parameters:

  field - The name of the Property

  value - The literal value

  Returns:

  A Filter

• boolean evaluate(Feature f)

  Evaluate the Filter against a Feature

• java.lang.String getCql()

  Get the CQL string from the Filter.

  Returns:

  The Filter as CQL

• Filter getNot()

  Get a new Filter that is the negation of the current Filter

  Returns:

  A new Filter that is the negation of the current Filter

• java.lang.String getXml(boolean pretty, double version)

  Get the XML string from the Filter.

  Parameters:

  pretty - Whether the XML is pretty printed (defaults to true)

  version - The version (defaults to 1.0)

  Returns:

  The Filter as XML

• int hashCode()

  Returns the hash code value of the Filter

  Returns:

  The hash code value of the Filter

• static Filter id(java.lang.String id)

  Create Filter for a Feature ID

  Parameters:

  id - A Feature ID

  Returns:

  A Filter

• static Filter ids(java.util.List ids)

  Create Filter for a List of Feature IDs

  Parameters:

  ids - A List of Feature IDs

  Returns:

  A Filter

• static Filter intersects(java.lang.String fieldName, Geometry geometry)

  Create a Spatial Filter that intersects the given Geometry

  Parameters:

  fieldName - The geometry field name (defaults to the_geom)

  bounds - The Bounds

  Returns:

  A Filter

• Filter negative()

  Get a new Filter that is the negation of the current Filter

  Returns:

  A new Filter that is the negation of the current Filter

• Filter or(java.lang.Object other)

  Combine the current Filter with another Filter in an OR relationship.

  Parameters:

  other - Another Filter or a CQL String

  Returns:

  A new Filter

• Filter plus(java.lang.Object other)

  Combine the current Filter with another Filter.

  Parameters:

  other - Another Filter or a CQL String

  Returns:

  A combined Filter

• Filter simplify()

  Simplify this Filter

  Returns:

  The new simplified Filter

• java.lang.String toString()

  The string representation

  Returns:

  The string representation