Package 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>
,java.lang.constant.Constable
,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 class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.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 LatLonShapeRelationstatic 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, 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
-
DISJOINT
-
WITHIN
-
CONTAINS
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 namejava.lang.NullPointerException
- if the argument is null
-
readFromStream
- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
getRelationByName
-
getLuceneRelation
public org.apache.lucene.document.ShapeField.QueryRelation getLuceneRelation()Maps ShapeRelation to Lucene's LatLonShapeRelation -
getRelationName
public java.lang.String getRelationName()
-