com.marklogic.client.query

Enum StructuredQueryBuilder.GeospatialOperator

java.lang.Object

java.lang.Enum<StructuredQueryBuilder.GeospatialOperator>

com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StructuredQueryBuilder.GeospatialOperator>

Enclosing class:

StructuredQueryBuilder

public static enum StructuredQueryBuilder.GeospatialOperator
extends java.lang.Enum<StructuredQueryBuilder.GeospatialOperator>

Geospatial operators to be used in geospatial region index queries

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINS
COVEREDBY
COVERS
CROSSES
DISJOINT
EQUALS
INTERSECTS
OVERLAPS
TOUCHES
WITHIN

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static StructuredQueryBuilder.GeospatialOperator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StructuredQueryBuilder.GeospatialOperator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQUALS

public static final StructuredQueryBuilder.GeospatialOperator EQUALS

DISJOINT

public static final StructuredQueryBuilder.GeospatialOperator DISJOINT

TOUCHES

public static final StructuredQueryBuilder.GeospatialOperator TOUCHES

CONTAINS

public static final StructuredQueryBuilder.GeospatialOperator CONTAINS

COVERS

public static final StructuredQueryBuilder.GeospatialOperator COVERS

INTERSECTS

public static final StructuredQueryBuilder.GeospatialOperator INTERSECTS

WITHIN

public static final StructuredQueryBuilder.GeospatialOperator WITHIN

COVEREDBY

public static final StructuredQueryBuilder.GeospatialOperator COVEREDBY

CROSSES

public static final StructuredQueryBuilder.GeospatialOperator CROSSES

OVERLAPS

public static final StructuredQueryBuilder.GeospatialOperator OVERLAPS

Method Detail

values

public static StructuredQueryBuilder.GeospatialOperator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StructuredQueryBuilder.GeospatialOperator c : StructuredQueryBuilder.GeospatialOperator.values())
    System.out.println(c);

Returns:

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

valueOf

public static StructuredQueryBuilder.GeospatialOperator valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<StructuredQueryBuilder.GeospatialOperator>