Module org.opengis.geoapi

Package org.opengis.filter

Class DistanceOperatorName

Object

CodeList<DistanceOperatorName>

DistanceOperatorName

All Implemented Interfaces:

Serializable, Comparable<DistanceOperatorName>, ControlledVocabulary

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

Nature of the spatial operation computed with geometries and a distance parameter.

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 DistanceOperatorName	BEYOND	Operator evaluates to true when all of a feature's geometry lies beyond (is more distant) than a given distance from the filter geometry.
static final DistanceOperatorName	WITHIN	Operator evaluates to true when any part of the first geometry lies within the given distance of the second geometry.

Method Summary

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

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

BEYOND

@UML(identifier="Beyond",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final DistanceOperatorName BEYOND

Operator evaluates to true when all of a feature's geometry lies beyond (is more distant) than a given distance from the filter geometry. More specifically:

Beyond(A,B,d) = Distance(A,B) > d

WITHIN

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

Operator evaluates to true when any part of the first geometry lies within the given distance of the second geometry. More specifically:

Within(A,B,d) = Distance(A,B) < d

Method Details

values

public static DistanceOperatorName[] values()

Returns the list of DistanceOperatorNames.

Returns:

the list of codes declared in the current JVM.

family

public DistanceOperatorName[] 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<DistanceOperatorName>

Returns:

all code values for this code list.

valueOf

public static DistanceOperatorName valueOf(String code)

Returns the distance 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.