Module org.opengis.geoapi

Package org.opengis.filter

Class LogicalOperatorName

Object

CodeList<LogicalOperatorName>

LogicalOperatorName

All Implemented Interfaces:

Serializable, Comparable<LogicalOperatorName>, ControlledVocabulary

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

Nature of the logic operation between two or more filters. The standard set of comparison operators is AND, OR and NOT.

Since:

3.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final LogicalOperatorName	AND	Operator evaluates to true if all the combined filters evaluate to true.
static final LogicalOperatorName	NOT	Operator reverses the logical value of a filter.
static final LogicalOperatorName	OR	Operator evaluates to true if any of the combined filters evaluate to true.

Method Summary

Modifier and Type	Method	Description
LogicalOperatorName[]	family()	Returns the list of codes of the same kind as this code list element.
static LogicalOperatorName	valueOf(String code)	Returns the binary logic type that matches the given string, or returns a new one if none match it.
static LogicalOperatorName[]	values()	Returns the list of LogicalOperatorNames.

Methods inherited from class org.opengis.util.CodeList

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

AND

@UML(identifier="And",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final LogicalOperatorName AND

Operator evaluates to true if all the combined filters evaluate to true.

OR

@UML(identifier="Or",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final LogicalOperatorName OR

Operator evaluates to true if any of the combined filters evaluate to true.

NOT

@UML(identifier="Not",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final LogicalOperatorName NOT

Operator reverses the logical value of a filter.

Method Details

values

public static LogicalOperatorName[] values()

Returns the list of LogicalOperatorNames.

Returns:

the list of codes declared in the current JVM.

family

public LogicalOperatorName[] family()

Returns the list of codes of the same kind as 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<LogicalOperatorName>

Returns:

all code values for this code list.

valueOf

public static LogicalOperatorName valueOf(String code)

Returns the binary logic type that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. 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.