com.mapbox.mapboxsdk.style.layers

Class Filter

java.lang.Object

com.mapbox.mapboxsdk.style.layers.Filter

public class Filter
extends java.lang.Object

Utility to build filter expressions more easily.

See Also:

The online documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.Statement Base Filter statement.

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
static Filter.Statement	all(Filter.Statement... statements) Groups a collection of statements in an 'all' relationship
static Filter.Statement	any(Filter.Statement... statements) Groups a collection of statements in an 'any' relationship
static Filter.Statement	eq(java.lang.String key, java.lang.Object value) Check the property equals the given value
static Filter.Statement	gt(java.lang.String key, java.lang.Object value) Check the property exceeds the given value
static Filter.Statement	gte(java.lang.String key, java.lang.Object value) Check the property exceeds or equals the given value
static Filter.Statement	has(java.lang.String key) Check the property's existence
static Filter.Statement	in(java.lang.String key, java.lang.Object... values) Check the property is within the given set
static Filter.Statement	lt(java.lang.String key, java.lang.Object value) Check the property does not exceeds the given value
static Filter.Statement	lte(java.lang.String key, java.lang.Object value) Check the property equals or does not exceeds the given value
static Filter.Statement	neq(java.lang.String key, java.lang.Object value) Check the property does not equals the given value
static Filter.Statement	none(Filter.Statement... statements) Groups a collection of statements in an 'none' relationship
static Filter.Statement	notHas(java.lang.String key) Check the property's existence, negated
static Filter.Statement	notIn(java.lang.String key, java.lang.Object... values) Check the property is not within the given set

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

all

public static Filter.Statement all(Filter.Statement... statements)

Groups a collection of statements in an 'all' relationship

Parameters:

statements - the collection of statements

Returns:

the statements compounded

any

public static Filter.Statement any(Filter.Statement... statements)

Groups a collection of statements in an 'any' relationship

Parameters:

statements - the collection of statements

Returns:

the statements compounded

none

public static Filter.Statement none(Filter.Statement... statements)

Groups a collection of statements in an 'none' relationship

Parameters:

statements - the collection of statements

Returns:

the statements compounded

has

public static Filter.Statement has(java.lang.String key)

Check the property's existence

Parameters:

key - the property key

Returns:

the statement

notHas

public static Filter.Statement notHas(java.lang.String key)

Check the property's existence, negated

Parameters:

key - the property key

Returns:

the statement

eq

public static Filter.Statement eq(java.lang.String key,
                                  java.lang.Object value)

Check the property equals the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

neq

public static Filter.Statement neq(java.lang.String key,
                                   java.lang.Object value)

Check the property does not equals the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

gt

public static Filter.Statement gt(java.lang.String key,
                                  java.lang.Object value)

Check the property exceeds the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

gte

public static Filter.Statement gte(java.lang.String key,
                                   java.lang.Object value)

Check the property exceeds or equals the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

lt

public static Filter.Statement lt(java.lang.String key,
                                  java.lang.Object value)

Check the property does not exceeds the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

lte

public static Filter.Statement lte(java.lang.String key,
                                   java.lang.Object value)

Check the property equals or does not exceeds the given value

Parameters:

key - the property key

value - the value to check against

Returns:

the statement

in

public static Filter.Statement in(java.lang.String key,
                                  java.lang.Object... values)

Check the property is within the given set

Parameters:

key - the property key

values - the set of values to check against

Returns:

the statement

notIn

public static Filter.Statement notIn(java.lang.String key,
                                     java.lang.Object... values)

Check the property is not within the given set

Parameters:

key - the property key

values - the set of values to check against

Returns:

the statement