org.elasticsearch.common.geo

Enum ShapeRelation

java.lang.Object

java.lang.Enum<ShapeRelation>

org.elasticsearch.common.geo.ShapeRelation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShapeRelation>, Writeable

public enum ShapeRelation
extends java.lang.Enum<ShapeRelation>
implements Writeable

Enum representing the relationship between a Query / Filter Shape and indexed Shapes that will be used to determine if a Document should be matched or not

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINS
DISJOINT
INTERSECTS
WITHIN

Method Summary

Modifier and Type	Method and Description
static ShapeRelation	getRelationByName(java.lang.String name)
java.lang.String	getRelationName()
static ShapeRelation	readFromStream(StreamInput in)
static ShapeRelation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ShapeRelation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTERSECTS

public static final ShapeRelation INTERSECTS

DISJOINT

public static final ShapeRelation DISJOINT

WITHIN

public static final ShapeRelation WITHIN

CONTAINS

public static final ShapeRelation CONTAINS

Method Detail

values

public static ShapeRelation[] 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 (ShapeRelation c : ShapeRelation.values())
    System.out.println(c);

Returns:

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

valueOf

public static ShapeRelation 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

readFromStream

public static ShapeRelation readFromStream(StreamInput in)
                                    throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getRelationByName

public static ShapeRelation getRelationByName(java.lang.String name)

getRelationName

public java.lang.String getRelationName()