ddf.catalog.filter.proxy.builder

Class GeotoolsFilterBuilder

java.lang.Object

ddf.catalog.filter.proxy.builder.GeotoolsFilterBuilder

All Implemented Interfaces:

FilterBuilder

public class GeotoolsFilterBuilder
extends Object
implements FilterBuilder

Author:

Michael Menousek, Lockheed Martin, ddf.isgs@lmco.com

Constructor Summary

Constructors

Constructor and Description
GeotoolsFilterBuilder()

Method Summary

Modifier and Type	Method and Description
org.opengis.filter.And	allOf(org.opengis.filter.Filter... filters) Create a new Filter that requires that all the provided Filters be satisfied.
org.opengis.filter.And	allOf(List<org.opengis.filter.Filter> filters) Create a new Filter that requires that all the provided Filters be satisfied.
org.opengis.filter.Or	anyOf(org.opengis.filter.Filter... filters) Create a new Filter that requires at least one of the provided Filters be satisfied.
org.opengis.filter.Or	anyOf(List<org.opengis.filter.Filter> filters) Create a new Filter that requires at least one of the provided Filters be satisfied.
AttributeBuilder	attribute(String string) Begin creating a Filter that will match Metacards based on Attributes with the given name.
ArgumentBuilder	function(String name) Begin creating a Filter that will call a function with the given name.
org.opengis.filter.Not	not(org.opengis.filter.Filter filter) Create a Filter that matches on Metacards that do not match the provided Filter
XPathBuilder	xpath(String xPathSelector) Begin creating a Filter that will match Metacards based on values selected via an XPath selector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeotoolsFilterBuilder

public GeotoolsFilterBuilder()

Method Detail

allOf

public org.opengis.filter.And allOf(org.opengis.filter.Filter... filters)

Description copied from interface: FilterBuilder

Create a new Filter that requires that all the provided Filters be satisfied.

Specified by:

allOf in interface FilterBuilder

Parameters:

filters - one or more Filters

Returns:

And Filter

anyOf

public org.opengis.filter.Or anyOf(org.opengis.filter.Filter... filters)

Description copied from interface: FilterBuilder

Create a new Filter that requires at least one of the provided Filters be satisfied.

Specified by:

anyOf in interface FilterBuilder

Parameters:

filters - List of Filters

Returns:

And Filter

attribute

public AttributeBuilder attribute(String string)

Description copied from interface: FilterBuilder

Begin creating a Filter that will match Metacards based on Attributes with the given name.

Note Because the Catalog's Filter profile uses attribute names and XPath selectors interchangeable, the provided Attribute name must not include the forward slash (/) or ampersand (@) characters, which are reserved for XPath selectors (see FilterBuilder.xpath(String).

XPath Filters will match on all Metacard Attributes that have a format of AttributeType.AttributeFormat.XML and match the XPath selector.

Specified by:

attribute in interface FilterBuilder

Parameters:

string - must not include "/" or "@"

Returns:

XPathBuilder to continue building an XPath Filter

function

public ArgumentBuilder function(String name)

Description copied from interface: FilterBuilder

Begin creating a Filter that will call a function with the given name. The function can require 0..N arguments.

Specified by:

function in interface FilterBuilder

Returns:

ArgumentBuilder to continue and add function arguments Filter

xpath

public XPathBuilder xpath(String xPathSelector)

Description copied from interface: FilterBuilder

Begin creating a Filter that will match Metacards based on values selected via an XPath selector.

Note Because the Catalog's Filter profile uses attribute names and XPath selectors interchangeable, XPath must include either the forward slash (/) or ampersand (@) character to indicate use of XPath.

XPath Filters will match on all Metacard Attributes that have a format of AttributeType.AttributeFormat.XML and match the XPath selector.

Specified by:

xpath in interface FilterBuilder

Parameters:

xPathSelector - must include "/" or "@"

Returns:

XPathBuilder to continue building an XPath Filter

not

public org.opengis.filter.Not not(org.opengis.filter.Filter filter)

Description copied from interface: FilterBuilder

Create a Filter that matches on Metacards that do not match the provided Filter

Specified by:

not in interface FilterBuilder

Parameters:

filter - the filter that should not be matched

Returns:

Not Filter

allOf

public org.opengis.filter.And allOf(List<org.opengis.filter.Filter> filters)

Description copied from interface: FilterBuilder

Create a new Filter that requires that all the provided Filters be satisfied.

Specified by:

allOf in interface FilterBuilder

Parameters:

filters - List of Filters

Returns:

And Filter

anyOf

public org.opengis.filter.Or anyOf(List<org.opengis.filter.Filter> filters)

Description copied from interface: FilterBuilder

Create a new Filter that requires at least one of the provided Filters be satisfied.

Specified by:

anyOf in interface FilterBuilder

Parameters:

filters - one or more Filters

Returns:

And Filter