Module org.opengis.geoapi

Package org.opengis.filter.capability

Interface FilterCapabilities

@UML(identifier="FilterCapabilities",
     specification=ISO_19143)
public interface FilterCapabilities

Metadata about the specific elements that a particular implementation supports. A client application can inspect the filter capabilities metadata and be able to determine which operators and types a filter expression processor supports.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
Conformance	getConformance()	Declaration of which conformance classes a particular implementation supports.
default Optional<ExtendedCapabilities>	getExtendedCapabilities()	Advertises any additional operators added to the filter syntax.
default Map<String,? extends AvailableFunction>	getFunctions()	Enumerates the functions that may be used in filter expressions.
default Optional<IdCapabilities>	getIdCapabilities()	Provides a list of element names that represent the resource identifier elements that the service supports.
default Optional<ScalarCapabilities>	getScalarCapabilities()	Advertises which logical, comparison and arithmetic operators the service supports.
default Optional<SpatialCapabilities>	getSpatialCapabilities()	Advertises which spatial operators and geometric operands the service supports.
default Optional<TemporalCapabilities>	getTemporalCapabilities()	Advertises which temporal operators and temporal operands the service supports.

Method Details

getConformance

@UML(identifier="conformance",
     obligation=MANDATORY,
     specification=ISO_19143)
Conformance getConformance()

Declaration of which conformance classes a particular implementation supports.

Returns:

declaration of which conformance classes a particular implementation supports.

getIdCapabilities

@UML(identifier="idCapabilities",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Optional<IdCapabilities> getIdCapabilities()

Provides a list of element names that represent the resource identifier elements that the service supports.

Returns:

capabilities used to convey supported identifier operators.

getScalarCapabilities

@UML(identifier="scalarCapabilities",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Optional<ScalarCapabilities> getScalarCapabilities()

Advertises which logical, comparison and arithmetic operators the service supports. If empty, then a client shall assume that the service does not support any logical or comparison operators and does not implement any additional functions.

Returns:

logical, comparison and arithmetic operators supported.

getSpatialCapabilities

@UML(identifier="spatialCapabilities",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Optional<SpatialCapabilities> getSpatialCapabilities()

Advertises which spatial operators and geometric operands the service supports. If empty, a client shall assume that the service does not support any spatial operators.

Returns:

capabilities used to convey supported spatial operators.

getTemporalCapabilities

@UML(identifier="temporalCapabilities",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Optional<TemporalCapabilities> getTemporalCapabilities()

Advertises which temporal operators and temporal operands the service supports. If empty, a client shall assume that the service does not support any temporal operators.

Returns:

capabilities used to convey supported temporal operators.

getFunctions

@UML(identifier="functions",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Map<String,? extends AvailableFunction> getFunctions()

Enumerates the functions that may be used in filter expressions. Keys are function names that can be used in calls to FilterFactory.function(String, Expression[]). Associated values are descriptions of the functions.

Invariants

For each entry, the key should be equal to AvailableFunction.getName().toString(), optionally with the LocalName replaced by a ScopedName for string representation purposes.

Returns:

the functions that may be used in filter expressions.

See Also:

• FilterFactory.function(String, Expression[])

getExtendedCapabilities

@UML(identifier="extendedCapabilities",
     obligation=OPTIONAL,
     specification=ISO_19143)
default Optional<ExtendedCapabilities> getExtendedCapabilities()

Advertises any additional operators added to the filter syntax.

Returns:

additional operators added to the filter syntax.