Package org.elasticsearch.common.geo

Enum Class ShapeRelation

java.lang.Object

java.lang.Enum<ShapeRelation>

org.elasticsearch.common.geo.ShapeRelation

All Implemented Interfaces:

Serializable, Comparable<ShapeRelation>, Constable, Writeable

public enum ShapeRelation
extends 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 class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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	Description
CONTAINS
DISJOINT
INTERSECTS
WITHIN

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.document.ShapeField.QueryRelation	getLuceneRelation()	Maps ShapeRelation to Lucene's LatLonShapeRelation
static ShapeRelation	getRelationByName(String name)
String	getRelationName()
static ShapeRelation	readFromStream(StreamInput in)
static ShapeRelation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShapeRelation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

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

readFromStream

public static ShapeRelation readFromStream(StreamInput in)
                                    throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getRelationByName

public static ShapeRelation getRelationByName(String name)

getLuceneRelation

public org.apache.lucene.document.ShapeField.QueryRelation getLuceneRelation()

Maps ShapeRelation to Lucene's LatLonShapeRelation

getRelationName

public String getRelationName()