Module org.opengis.geoapi

Package org.opengis.filter

Enum Class MatchAction

Object

Enum<MatchAction>

MatchAction

All Implemented Interfaces:

Serializable, Comparable<MatchAction>, Constable, ControlledVocabulary

@UML(identifier="MatchAction",
     specification=ISO_19143)
public enum MatchAction
extends Enum<MatchAction>
implements ControlledVocabulary

Specifies how the comparison predicate shall be evaluated for a collection of values. This enumeration does not specify which specific value from the collection is tested.

Since:

3.1

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All values in the collection shall satisfy the predicate.
ANY	Any of the value in the collection can satisfy the predicate.
ONE	One of the values in the collection shall satisfy the predicate.

Method Summary

Modifier and Type	Method	Description
MatchAction[]	family()	Returns all constants defined by this enumeration type.
String	identifier()	Returns the UML identifier for this enumeration constant.
String[]	names()	Returns the programmatic name of this constant together with its identifier.
static MatchAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MatchAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ControlledVocabulary

name, ordinal

Enum Constant Details

ANY

@UML(identifier="any",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final MatchAction ANY

Any of the value in the collection can satisfy the predicate. This is the default value.

ALL

@UML(identifier="all",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final MatchAction ALL

All values in the collection shall satisfy the predicate.

ONE

@UML(identifier="one",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final MatchAction ONE

One of the values in the collection shall satisfy the predicate. Additional context may specify which value in the collection should satisfy the predicate. For example, the index may be a parameter in an expression.

Method Details

values

public static MatchAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MatchAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

identifier

public String identifier()

Returns the UML identifier for this enumeration constant.

Specified by:

identifier in interface ControlledVocabulary

Returns:

the ISO/OGC identifier for this constant, or null if none.

names

public String[] names()

Returns the programmatic name of this constant together with its identifier.

Specified by:

names in interface ControlledVocabulary

Returns:

all names of this constant. This array is never null and never empty.

family

public MatchAction[] family()

Returns all constants defined by this enumeration type. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the ControlledVocabulary interface (i.e. the enumeration type does not need to be known at compile-time).

Specified by:

family in interface ControlledVocabulary

Returns:

all values for this enumeration.