Object

AbstractFactory

DefaultFilterFactory<AbstractFeature, G, T>

Features<G,T>

Type Parameters:: G - base class of geometry objects. The implementation-neutral type is GeoAPI Geometry, but this factory allows the use of other implementations such as JTS Geometry or ESRI Geometry.; T - base class of temporal objects.

All Implemented Interfaces:: Factory

Enclosing class:: DefaultFilterFactory<R,G,T>

public static class DefaultFilterFactory.Features<G,T> extends DefaultFilterFactory<AbstractFeature, G, T>

A filter factory operating on

invalid reference

Feature

instances.

Since:: 1.1

Nested Class Summary
Nested classes/interfaces inherited from class DefaultFilterFactory
DefaultFilterFactory.Features<G,T>
Modifier and Type

Class

Description

static class

DefaultFilterFactory.Features<G,T>
A filter factory operating on

invalid reference

Feature

instances.
Constructor Summary

Constructors

Constructor

Description

Features(Class<G> spatial, Class<T> temporal, WraparoundMethod wraparound)

Creates a new factory operating on AbstractFeature instances.
Method Summary

Modifier and Type

Method

Description

<V> Expression<AbstractFeature, V>

property(String xpath, Class<V> type)

Creates an expression whose value is computed by retrieving the value indicated by a path in a resource.

Filter<AbstractFeature>

resourceId(String identifier)

Creates a new predicate to identify an identifiable resource within a filter expression.

Methods inherited from class DefaultFilterFactory
add, after, and, and, anyInteracts, bbox, before, begins, begunBy, between, beyond, contains, crosses, disjoint, divide, during, endedBy, ends, equal, equals, forFeatures, forResources, function, function, function, greater, greaterOrEqual, intersects, isNil, isNull, less, lessOrEqual, like, like, literal, meets, metBy, multiply, not, notEqual, or, or, overlappedBy, overlaps, property, subtract, tcontains, tequals, toString, touches, toverlaps, within, within

Modifier and Type

Method

Description

Expression<AbstractFeature, Number>

add(Expression<AbstractFeature, ? extends Number> operand1, Expression<AbstractFeature, ? extends Number> operand2)

Creates a function computing the numeric addition of the first and second operand.

Filter<AbstractFeature>

after(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is after the second.

Filter<AbstractFeature>

and(Collection<? extends Filter<AbstractFeature>> operands)

Creates a AND filter between two or more filters.

Filter<AbstractFeature>

and(Filter<AbstractFeature> operand1, Filter<AbstractFeature> operand2)

Creates a AND filter between two filters.

Filter<AbstractFeature>

anyInteracts(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates a shortcut operator semantically equivalent to NOT (Before OR Meets OR MetBy OR After).

Filter<AbstractFeature>

bbox(Expression<AbstractFeature, ? extends G> geometry, Envelope bounds)

Creates an operator that checks if the bounding box of the feature's geometry interacts with the bounding box provided in the filter properties.

Filter<AbstractFeature>

before(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is before the second.

Filter<AbstractFeature>

begins(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand begins at the second.

Filter<AbstractFeature>

begunBy(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand begun by the second.

Filter<AbstractFeature>

between(Expression<AbstractFeature, ?> expression, Expression<AbstractFeature, ?> lowerBoundary, Expression<AbstractFeature, ?> upperBoundary)

Filter operation for a range check.

Filter<AbstractFeature>

beyond(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2, Quantity<Length> distance)

Creates an operator that checks if all of a feature's geometry is more distant than the given distance from the given geometry.

Filter<AbstractFeature>

contains(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the first geometric operand contains the second.

Filter<AbstractFeature>

crosses(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the first geometric operand crosses the second.

Filter<AbstractFeature>

disjoint(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the first operand is disjoint from the second.

Expression<AbstractFeature, Number>

divide(Expression<AbstractFeature, ? extends Number> operand1, Expression<AbstractFeature, ? extends Number> operand2)

Creates a function computing the numeric quotient resulting from dividing the first operand by the second.

Filter<AbstractFeature>

during(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is during the second.

Filter<AbstractFeature>

endedBy(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is ended by the second.

Filter<AbstractFeature>

ends(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand ends at the second.

Filter<AbstractFeature>

equal(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that compares that two sub-expressions are equal to each other.

Filter<AbstractFeature>

equals(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the geometry of the two operands are equal.

static DefaultFilterFactory<AbstractFeature, Object, Object>

forFeatures()

Returns a factory operating on AbstractFeature instances.

static <R> Optional<DefaultFilterFactory<R,Object,Object>>

forResources(Class<R> type)

Returns a factory operating on resource instances of the given class.

Expression<AbstractFeature, ?>

function(String name, Expression<? super AbstractFeature, ?> parameter)

Creates an implementation-specific function with a single parameter.

Expression<AbstractFeature, ?>

function(String name, Expression<? super AbstractFeature, ?> param1, Expression<? super AbstractFeature, ?> param2)

Creates an implementation-specific function with two parameters.

Expression<AbstractFeature, ?>

function(String name, Expression<AbstractFeature, ?>[] parameters)

Creates an implementation-specific function.

Filter<AbstractFeature>

greater(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that checks that its first sub-expression is greater than its second sub-expression.

Filter<AbstractFeature>

greaterOrEqual(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that checks that its first sub-expression is greater than its second sub-expression.

Filter<AbstractFeature>

intersects(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the two geometric operands intersect.

Filter<AbstractFeature>

isNil(Expression<AbstractFeature, ?> expression, String nilReason)

An operator that tests if an expression's value is nil.

Filter<AbstractFeature>

isNull(Expression<AbstractFeature, ?> expression)

An operator that tests if an expression's value is null.

Filter<AbstractFeature>

less(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that checks that its first sub-expression is less than its second sub-expression.

Filter<AbstractFeature>

lessOrEqual(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that checks that its first sub-expression is less than or equal to its second sub-expression.

Filter<AbstractFeature>

like(Expression<AbstractFeature, ?> expression, String pattern)

Character string comparison operator with pattern matching and default wildcards.

Filter<AbstractFeature>

like(Expression<AbstractFeature, ?> expression, String pattern, char wildcard, char singleChar, char escape, boolean isMatchingCase)

Character string comparison operator with pattern matching and specified wildcards.

<V> Expression<AbstractFeature, V>

literal(V value)

Creates a constant, literal value that can be used in expressions.

Filter<AbstractFeature>

meets(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand meets the second.

Filter<AbstractFeature>

metBy(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is met by the second.

Expression<AbstractFeature, Number>

multiply(Expression<AbstractFeature, ? extends Number> operand1, Expression<AbstractFeature, ? extends Number> operand2)

Creates a function computing the numeric product of their first and second operand.

Filter<AbstractFeature>

not(Filter<AbstractFeature> operand)

Creates a NOT filter for the given filter.

Filter<AbstractFeature>

notEqual(Expression<AbstractFeature, ?> expression1, Expression<AbstractFeature, ?> expression2)

Filter operator that compares that its two sub-expressions are not equal to each other.

Filter<AbstractFeature>

or(Collection<? extends Filter<AbstractFeature>> operands)

Creates a OR filter between two or more filters.

Filter<AbstractFeature>

or(Filter<AbstractFeature> operand1, Filter<AbstractFeature> operand2)

Creates a OR filter between two filters.

Filter<AbstractFeature>

overlappedBy(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is overlapped by the second.

Filter<AbstractFeature>

overlaps(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the interior of the first geometric operand somewhere overlaps the interior of the second geometric operand.

Expression<AbstractFeature, ?>

property(String xpath)

Creates an expression whose value is computed by retrieving the value indicated by a path in a resource.

Expression<AbstractFeature, Number>

subtract(Expression<AbstractFeature, ? extends Number> operand1, Expression<AbstractFeature, ? extends Number> operand2)

Creates a function computing the numeric difference between the first and second operand.

Filter<AbstractFeature>

tcontains(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is contained by the second.

Filter<AbstractFeature>

tequals(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand is equal to the second.

String

toString()

Returns a string representation of this factory for debugging purposes.

Filter<AbstractFeature>

touches(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the two geometric operands touch each other, but do not overlap.

Filter<AbstractFeature>

toverlaps(Expression<AbstractFeature, ? extends T> time1, Expression<AbstractFeature, ? extends T> time2)

Creates an operator that checks if first temporal operand overlaps the second.

Filter<AbstractFeature>

within(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2)

Creates an operator that checks if the first geometric operand is completely contained by the constant geometric operand.

Filter<AbstractFeature>

within(Expression<AbstractFeature, ? extends G> geometry1, Expression<AbstractFeature, ? extends G> geometry2, Quantity<Length> distance)

Creates an operator that checks if any part of the first geometry lies within the given distance of the second geometry.

Methods inherited from class AbstractFactory
getVendor

Modifier and Type

Method

Description

Citation

getVendor()

Returns the implementer of this factory, or null if unknown.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- Features
  public Features(Class<G> spatial, Class<T> temporal, WraparoundMethod wraparound)
  
  Creates a new factory operating on AbstractFeature instances. See the DefaultFilterFactory(Class, Class, WraparoundMethod) super-class constructor} for a list of valid class arguments.
  
  Parameters:
  
  spatial - type of spatial objects, or Object.class for default.
  
  temporal - type of temporal objects, or Object.class for any supported type.
  
  wraparound - the strategy to use for representing a region crossing the anti-meridian.
  
  See Also:
  
  DefaultFilterFactory.forFeatures()
Method Details
- resourceId
  
  public Filter<AbstractFeature> resourceId(String identifier)
  
  Creates a new predicate to identify an identifiable resource within a filter expression.
  
  Specified by:
  
  resourceId in class DefaultFilterFactory<AbstractFeature, G, T>
  
  Parameters:
  
  identifier - identifier of the resource that shall be selected by the predicate.
  
  Returns:
  
  the predicate.
- property
  
  public <V> Expression<AbstractFeature, V> property(String xpath, Class<V> type)
  
  Creates an expression whose value is computed by retrieving the value indicated by a path in a resource. If all characters in the path are Unicode identifier parts, then the XPath expression is simply a property name.
  The desired type of property values can be specified. For example if the property values should be numbers, then type can be Number.class. If property values can be of any type with no conversion desired, then type should be Object.class.
  
  Supported XPath syntax
  If the given xpath contains the "/" character, then all path components before the last one are interpreted as associations to follow. For example if the XPath is "client/name", then the ValueReference applied on feature F will first search for an association named "client" to feature C, then search for a property named "name" in feature C.
  The given xpath may contain scoped names. For example "foo:client" is the name "client" in scope "foo". If the scope is an URL, then it needs to be enclosed inside "Q{…}". Example: "Q{http://www.foo.com/bar}client".
  
  Specified by:
  
  property in class DefaultFilterFactory<AbstractFeature, G, T>
  
  Type Parameters:
  
  V - the type of the values to be fetched (compile-time value of type).
  
  Parameters:
  
  xpath - the path to the property whose value will be returned by the apply(R) method.
  
  type - the type of the values to be fetched (run-time value of <V>).
  
  Returns:
  
  an expression evaluating the referenced property value.

Class DefaultFilterFactory.Features<G,T>

Nested Class Summary

Nested classes/interfaces inherited from class DefaultFilterFactory

Constructor Summary

Method Summary

Methods inherited from class DefaultFilterFactory

Methods inherited from class AbstractFactory

Methods inherited from class Object

Constructor Details

Features

Method Details

resourceId

property

Supported XPath syntax