org.geomajas.service

Interface FilterService

@Api(allMethods=true)
public interface FilterService

Filter creator service.

Since:

1.6.0

Author:

Joachim Van der Auwera

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_ID Generic attribute name which can be used to reference the id attribute (whatever the actual name is).

Method Summary

Methods

Modifier and Type	Method and Description
Filter	createAndFilter(Filter left, Filter right) Combine two filters using the "AND" operator.
Filter	createBboxFilter(Crs crs, com.vividsolutions.jts.geom.Envelope bbox, String geomName) Create a filter the evaluates all geometries within a certain bounding box.
Filter	createBboxFilter(String epsg, com.vividsolutions.jts.geom.Envelope bbox, String geomName) Create a filter the evaluates all geometries within a certain bounding box.
Filter	createBetweenFilter(String name, String lower, String upper) Create a filter which passes all features from the FeatureInfo within featureTypeInfo with attribute values from attribute 'name' between values 'lower and 'upper'. This type of filter is only allowed on numeric object types (short, integer, long, float, double)
Filter	createCompareFilter(String name, String comparator, Date value) Create a filter that passes all features where the values of attribute 'name' compared to literal 'value' using comparator 'comparator' returns true.
Filter	createCompareFilter(String name, String comparator, String value) Create a filter that passes all features where the values of attribute 'name' compared to literal 'value' using comparator 'comparator' returns true.
Filter	createContainsFilter(com.vividsolutions.jts.geom.Geometry geometry, String geomName) Create a filter with all the geometries that contain the given geometry (including the geometry itself).
Filter	createFalseFilter() Creates a filter that allows nothing.
Filter	createFidFilter(String[] featureIDs) Create a feature ID filter.
Filter	createGeometryTypeFilter(String geomName, String geometryType) Create a filter that checks that passes all features with the specified geometry type.
Filter	createIntersectsFilter(com.vividsolutions.jts.geom.Geometry geometry, String geomName) Create a filter with all the geometries that have a non-empty intersection (overlap or touching) with given geometry (including the geometry itself).
Filter	createLikeFilter(String name, String pattern) Filter based on the LIKE comparator as in sql.
Filter	createLogicFilter(Filter filter1, String logic, Filter filter2) Create a logic filter.
Filter	createOrFilter(Filter left, Filter right) Combine two filters using the "OR" operator.
Filter	createOverlapsFilter(com.vividsolutions.jts.geom.Geometry geometry, String geomName) Create a filter with all the geometries that overlap the given geometry.
Filter	createTouchesFilter(com.vividsolutions.jts.geom.Geometry geometry, String geomName) Creates a filter with all the geometries that touch the given geometry.
Filter	createTrueFilter() Creates a filter that allows everything.
Filter	createWithinFilter(com.vividsolutions.jts.geom.Geometry geometry, String geomName) Create a filter with all the geometries that lie completely within the given geometry (including the geometry itself).
FilterFactory	getFilterFactory() Get filter factory which is used by the implementation.
Filter	parseFilter(String filter) Parse a string to build a filter object.
void	registerFeatureModel(FeatureModel featureModel) Register a feature model.

Field Detail

ATTRIBUTE_ID

static final String ATTRIBUTE_ID

Generic attribute name which can be used to reference the id attribute (whatever the actual name is).

Since:

1.11.0

See Also:

Constant Field Values

Method Detail

createBetweenFilter

Filter createBetweenFilter(String name,
                         String lower,
                         String upper)

Create a filter which passes all features from the FeatureInfo within featureTypeInfo with attribute values from attribute 'name' between values 'lower and 'upper'.
This type of filter is only allowed on numeric object types (short, integer, long, float, double)

Parameters:

name - The name of the attribute from featureTypeInfo.

lower - A literal. A string that can be converted to a double.

upper - A literal. A string that can be converted to a double.

Returns:

filter

createLikeFilter

Filter createLikeFilter(String name,
                      String pattern)

Filter based on the LIKE comparator as in sql. arg2 is a string to compare the values of arg1 with. Make sure arg1 refers to a String-attribute. The expression understands wildcards like *(= zero or more unknown characters) and ?(exactly 1 unknown character).

Parameters:

name - The name of the attribute from featureTypeInfo.

pattern - Expression to compare with.

Returns:

filter

createCompareFilter

Filter createCompareFilter(String name,
                         String comparator,
                         String value)

Create a filter that passes all features where the values of attribute 'name' compared to literal 'value' using comparator 'comparator' returns true.

Parameters:

name - The name of the attribute from featureTypeInfo. This type of filter is only allowed on numeric object types (short, integer, long, float, double)

comparator - Depending on the type of literal, a range of operators is supported.

• For numeric object types (short, integer, long, float, double) all of the following operators are supported: "<", "<=", ">", ">=", "==", "<>".
• For boolean and string: "==" and "<>"
• Dates have their own method...

value - A literal. The actual value (as string).

Returns:

filter

createCompareFilter

Filter createCompareFilter(String name,
                         String comparator,
                         Date value)

Create a filter that passes all features where the values of attribute 'name' compared to literal 'value' using comparator 'comparator' returns true. This function compares object of the type Date.

Parameters:

name - The name of the attribute from featureTypeInfo. This type of filter is only allowed on dates.

comparator - The sort of comparison, can be "<", "<=", ">", ">=", "==", "<>".

value - A literal. A string that can be converted to a double.

Returns:

filter

createGeometryTypeFilter

Filter createGeometryTypeFilter(String geomName,
                              String geometryType)

Create a filter that checks that passes all features with the specified geometry type.

Parameters:

geomName - name of geometry attribute, empty string will choose default geometry

geometryType - the geometry type ('Point', 'MultiPoint', 'LineString', 'MultiLineString', 'Polygon' or 'MultiPolygon', see FilterFunction)

Returns:

filter

Since:

1.9.0

createLogicFilter

Filter createLogicFilter(Filter filter1,
                       String logic,
                       Filter filter2)

Create a logic filter. This is a combination of filters.

Parameters:

filter1 - first filter to combine

logic - The logic operator. Can be 'AND', 'OR', 'NOT'.

filter2 - second filter to combine In the case of "NOT", this parameter is not used.

Returns:

filter

createFidFilter

Filter createFidFilter(String[] featureIDs)

Create a feature ID filter.

Parameters:

featureIDs - Array of identifier strings for the features that need looking up.

Returns:

filter

createWithinFilter

Filter createWithinFilter(com.vividsolutions.jts.geom.Geometry geometry,
                        String geomName)

Create a filter with all the geometries that lie completely within the given geometry (including the geometry itself).

Parameters:

geometry - the geometry

geomName - the name of the geometry field

Returns:

filter

createContainsFilter

Filter createContainsFilter(com.vividsolutions.jts.geom.Geometry geometry,
                          String geomName)

Create a filter with all the geometries that contain the given geometry (including the geometry itself).

Parameters:

geometry - the geometry

geomName - the name of the geometry field

Returns:

filter

createIntersectsFilter

Filter createIntersectsFilter(com.vividsolutions.jts.geom.Geometry geometry,
                            String geomName)

Create a filter with all the geometries that have a non-empty intersection (overlap or touching) with given geometry (including the geometry itself).

Parameters:

geometry - the geometry

geomName - the name of the geometry field

Returns:

filter

createTouchesFilter

Filter createTouchesFilter(com.vividsolutions.jts.geom.Geometry geometry,
                         String geomName)

Creates a filter with all the geometries that touch the given geometry.

Parameters:

geometry - the geometry

geomName - the name of the geometry field

Returns:

filter

createBboxFilter

Filter createBboxFilter(String epsg,
                      com.vividsolutions.jts.geom.Envelope bbox,
                      String geomName)

Create a filter the evaluates all geometries within a certain bounding box.

Parameters:

epsg - The bounding box' coordinate system reference.

bbox - The bounding box itself.

geomName - The name of the geometry field

Returns:

filter

createBboxFilter

Filter createBboxFilter(Crs crs,
                      com.vividsolutions.jts.geom.Envelope bbox,
                      String geomName)

Create a filter the evaluates all geometries within a certain bounding box.

Parameters:

crs - The bounding box' coordinate reference system.

bbox - The bounding box itself.

geomName - The name of the geometry field

Returns:

filter

Since:

1.9.0

createOverlapsFilter

Filter createOverlapsFilter(com.vividsolutions.jts.geom.Geometry geometry,
                          String geomName)

Create a filter with all the geometries that overlap the given geometry.

Parameters:

geometry - the geometry

geomName - the name of the geometry field

Returns:

filter

createTrueFilter

Filter createTrueFilter()

Creates a filter that allows everything.

Returns:

filter

createFalseFilter

Filter createFalseFilter()

Creates a filter that allows nothing.

Returns:

filter

registerFeatureModel

void registerFeatureModel(FeatureModel featureModel)

Register a feature model.

Only feature models which are registered can be used when filtering.

Parameters:

featureModel - feature model to register

createAndFilter

Filter createAndFilter(Filter left,
                     Filter right)

Combine two filters using the "AND" operator.

Parameters:

left - first filter to combine

right - second filter to combine

Returns:

new filter combining the parameters using "and"

createOrFilter

Filter createOrFilter(Filter left,
                    Filter right)

Combine two filters using the "OR" operator.

Parameters:

left - first filter to combine

right - second filter to combine

Returns:

new filter combining the parameters using "or"

Since:

1.10.0

parseFilter

Filter parseFilter(String filter)
                   throws GeomajasException

Parse a string to build a filter object.

Parameters:

filter - filter as string

Returns:

actual filter

Throws:

GeomajasException - could not parse string to filter

getFilterFactory

FilterFactory getFilterFactory()

Get filter factory which is used by the implementation.

Returns:

filter factory

Since:

1.11.0