com.sksamuel.elastic4s.requests.searches.queries.geo.GeoShapeQuery.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elastic4s-domain_3 Show documentation
elastic4s-domain
There is a newer version: 8.15.4
package com.sksamuel.elastic4s.requests.searches.queries.geo

import com.sksamuel.elastic4s.Index
import com.sksamuel.elastic4s.requests.searches.GeoPoint
import com.sksamuel.elastic4s.requests.searches.queries.Query
import com.sksamuel.elastic4s.requests.searches.queries.geo.Shapes.{Circle, Polygon}
import com.sksamuel.elastic4s.ext.OptionImplicits._

sealed trait ShapeDefinition {
  def geoShapeType: GeoShapeType
}

sealed trait SingleShape extends ShapeDefinition

case class PointShape(point: GeoPoint) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.POINT
}

case class CircleShape(circle: Circle) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.CIRCLE
}

case class PolygonShape(polygon: Polygon) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.POLYGON
}

case class MultiPointShape(points: Seq[GeoPoint]) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.MULTIPOINT
}

case class LineStringShape(
  p1: GeoPoint,
  p2: GeoPoint,
  path: GeoPoint*
) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.LINESTRING
}

case class EnvelopeShape(
  upperLeft: GeoPoint,
  lowerRight: GeoPoint
) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.ENVELOPE
}

case class MultiLineStringShape(coordinates: Seq[Seq[GeoPoint]]) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.MULTILINESTRING
}

case class MultiPolygonShape(coordinate: Seq[Polygon]) extends SingleShape {
  def geoShapeType: GeoShapeType = GeoShapeType.MULTIPOLYGON
}

sealed trait CollectionShape extends ShapeDefinition
case class GeometryCollectionShape(shapes: Seq[ShapeDefinition]) extends CollectionShape {
  def geoShapeType: GeoShapeType = GeoShapeType.GEOMETRYCOLLECTION
}

sealed trait Shape
case class InlineShape(shape: ShapeDefinition)                                     extends Shape
case class PreindexedShape(id: String, index: Index, path: String) extends Shape

case class GeoShapeQuery(field: String,
                         shape: Shape,
                         relation: Option[ShapeRelation] = None,
                         boost: Option[Double] = None,
                         queryName: Option[String] = None,
                         strategy: Option[SpatialStrategy] = None,
                         ignoreUnmapped: Option[Boolean] = None)
    extends Query {

  def relation(relation: ShapeRelation): GeoShapeQuery   = copy(relation = relation.some)
  def boost(boost: Double): GeoShapeQuery                = copy(boost = boost.some)
  def queryName(queryName: String): GeoShapeQuery        = copy(queryName = queryName.some)
  def strategy(strategy: SpatialStrategy): GeoShapeQuery = copy(strategy = strategy.some)

  def inlineShape(shape: ShapeDefinition): GeoShapeQuery = copy(shape = InlineShape(shape))
  def preindexedShape(id: String, index: Index, path: String): GeoShapeQuery =
    copy(shape = PreindexedShape(id, index, path))

  def ignoreUnmapped(ignore: Boolean): GeoShapeQuery = copy(ignoreUnmapped = ignore.some)
}

trait GeoShapeType
object GeoShapeType {
  case object POINT              extends GeoShapeType
  case object MULTIPOINT         extends GeoShapeType
  case object LINESTRING         extends GeoShapeType
  case object MULTILINESTRING    extends GeoShapeType
  case object POLYGON            extends GeoShapeType
  case object MULTIPOLYGON       extends GeoShapeType
  case object GEOMETRYCOLLECTION extends GeoShapeType
  case object ENVELOPE           extends GeoShapeType
  case object CIRCLE             extends GeoShapeType
}

trait ShapeRelation
object ShapeRelation {
  case object INTERSECTS extends ShapeRelation
  case object DISJOINT   extends ShapeRelation
  case object WITHIN     extends ShapeRelation
  case object CONTAINS   extends ShapeRelation
  val intersects = INTERSECTS
  val disjoint   = DISJOINT
  val within     = WITHIN
  val contains   = CONTAINS
}

trait SpatialStrategy
object SpatialStrategy {
  case object Term      extends SpatialStrategy
  case object Recursive extends SpatialStrategy
}