Module org.opengis.geoapi

Package org.opengis.filter

Class SpatialOperatorName

Object

CodeList<SpatialOperatorName>

SpatialOperatorName

All Implemented Interfaces:

Serializable, Comparable<SpatialOperatorName>, ControlledVocabulary

@UML(identifier="SpatialOperatorName",
     specification=ISO_19143)
public final class SpatialOperatorName
extends CodeList<SpatialOperatorName>

Nature of the spatial operation between two geometries.

Since:

3.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final SpatialOperatorName	BBOX	Operator evaluates to true when the bounding box of the feature's geometry interacts with the bounding box provided in the filter properties.
static final SpatialOperatorName	CONTAINS	Operator evaluates to true if the first geometric operand contains the second.
static final SpatialOperatorName	CROSSES	Operator evaluates to true if the first geometric operand crosses the second.
static final SpatialOperatorName	DISJOINT	Operator evaluates to true if the first operand is disjoint from the second.
static final SpatialOperatorName	EQUALS	Operator evaluates to true if the geometry of the two operands are equal.
static final SpatialOperatorName	INTERSECTS	Operator evaluates to true if the two geometric operands intersect.
static final SpatialOperatorName	OVERLAPS	Operator evaluates to true if the interior of the first geometric operand somewhere overlaps the interior of the second geometric operand.
static final SpatialOperatorName	TOUCHES	Operator evaluates to true if the two geometric operands touch, but do not overlap.
static final SpatialOperatorName	WITHIN	Operator evaluates to true if the first geometric operand is completely contained by the constant geometric operand.

Method Summary

Modifier and Type	Method	Description
SpatialOperatorName[]	family()	Returns the list of codes of the same kind than this code list element.
static SpatialOperatorName	valueOf(String code)	Returns the spatial operator that matches the given string, or returns a new one if none match it.
static SpatialOperatorName[]	values()	Returns the list of SpatialOperatorNames.

Methods inherited from class CodeList

compareTo, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf, valueOf

Methods inherited from class Object

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

Field Details

BBOX

@UML(identifier="BBOX",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName BBOX

Operator evaluates to true when the bounding box of the feature's geometry interacts with the bounding box provided in the filter properties. The geometry is given by the first expression and the bounding box is the envelope given by the second expression.

The BBOX operation is defined as a convenient and more compact way of expressing the very common bounding box constraint based on the envelope geometry. It is equivalent to the spatial operation NOT DISJOINT meaning that the BBOX operator identifies all geometries that spatially interact with the box.

An implementation may choose to throw an exception if one attempts to test features that are in a different SRS than the SRS contained in the filter.

EQUALS

@UML(identifier="Equals",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName EQUALS

Operator evaluates to true if the geometry of the two operands are equal.

DISJOINT

@UML(identifier="Disjoint",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName DISJOINT

Operator evaluates to true if the first operand is disjoint from the second. "Disjoint" shall be interpreted in the sense defined in the OGC Simple Features specification.

INTERSECTS

@UML(identifier="Intersects",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName INTERSECTS

Operator evaluates to true if the two geometric operands intersect.

TOUCHES

@UML(identifier="Touches",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName TOUCHES

Operator evaluates to true if the two geometric operands touch, but do not overlap.

CROSSES

@UML(identifier="Crosses",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName CROSSES

Operator evaluates to true if the first geometric operand crosses the second. "Cross" shall be interpreted in the sense defined by the OGC Simple Features specification.

WITHIN

@UML(identifier="Within",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName WITHIN

Operator evaluates to true if the first geometric operand is completely contained by the constant geometric operand.

CONTAINS

@UML(identifier="Contains",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName CONTAINS

Operator evaluates to true if the first geometric operand contains the second.

OVERLAPS

@UML(identifier="Overlaps",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SpatialOperatorName OVERLAPS

Operator evaluates to true if the interior of the first geometric operand somewhere overlaps the interior of the second geometric operand.

Method Details

values

public static SpatialOperatorName[] values()

Returns the list of SpatialOperatorNames.

Returns:

the list of codes declared in the current JVM.

family

public SpatialOperatorName[] family()

Returns the list of codes of the same kind than this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<SpatialOperatorName>

Returns:

all code values for this code list.

valueOf

public static SpatialOperatorName valueOf(String code)

Returns the spatial operator that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.