Module org.opengis.geoapi

Package org.opengis.filter

Interface ResourceId<R>

Type Parameters:

R - the type of resources (e.g. Feature) to filter.

All Superinterfaces:

Filter<R>, Predicate<R>

@UML(identifier="SpatialOperator",
     specification=ISO_19143)
public interface ResourceId<R>
extends Filter<R>

Predicate to identify any identifiable resource within a filter expression. This predicates uses a unique identifier for an instance of a resource within the context of the service that is serving the resource.

Versioning

The identifier property is mandatory. Other properties can be used to navigate versions of a resource if an implementation supports versioning. If an implementation does not support versioning, any value specified for these attributes are ignored and the predicate always select the single version that is available.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
default Optional<Instant>	getEndTime()	Selects all versions of a resource between the specified start date and end date.
String	getIdentifier()	Specifies the identifier of the resource that shall be selected by the predicate.
default CodeList<?>	getOperatorType()	Returns the nature of this operator.
default Optional<Instant>	getStartTime()	Selects all versions of a resource between the specified start date and end date.
default Optional<Version>	getVersion()	Specifies which version of the resource shall be selected.

Methods inherited from interface org.opengis.filter.Filter

getExpressions, getResourceClass, test

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

getOperatorType

default CodeList<?> getOperatorType()

Returns the nature of this operator. The default implementation returns RESOURCE_ID.

Specified by:

getOperatorType in interface Filter<R>

Returns:

the nature of the operator.

getIdentifier

@UML(identifier="rid",
     obligation=MANDATORY,
     specification=ISO_19143)
String getIdentifier()

Specifies the identifier of the resource that shall be selected by the predicate. If the implementation supports versioning, this identifier is a system generated hash containing a logical resource identifier and a version number. The specific details of the hash are implementation dependent and is opaque to clients.

Returns:

the identifier of the resource that shall be selected by the predicate.

getVersion

@UML(identifier="version",
     obligation=CONDITIONAL,
     specification=ISO_19143)
default Optional<Version> getVersion()

Specifies which version of the resource shall be selected. The version may be an integer indicating the N^th version, a date for selecting the version closest to the specified date, or an action such as FIRST, LATEST, PREVIOUS, NEXT or ALL.

Returns:

version of the resource to select.

getStartTime

@UML(identifier="startTime",
     obligation=CONDITIONAL,
     specification=ISO_19143)
default Optional<Instant> getStartTime()

Selects all versions of a resource between the specified start date and end date. The startTime and endTime attributes shall always be specified together. If the startTime and endTime are specified, then the version attribute shall not be specified.

Returns:

start date and time of versions to select.

getEndTime

@UML(identifier="endTime",
     obligation=CONDITIONAL,
     specification=ISO_19143)
default Optional<Instant> getEndTime()

Selects all versions of a resource between the specified start date and end date. The startTime and endTime attributes shall always be specified together. If the startTime and endTime are specified, then the version attribute shall not be specified.

Returns:

end date and time of versions to select.