astraea.spark.rasterframes.jts.Implicits.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of raster-frames_2.11 Show documentation

RasterFrames brings the power of Spark DataFrames to geospatial raster data, empowered by the map algebra and tile layer operations of GeoTrellis

The newest version!

/*
 * This software is licensed under the Apache 2 license, quoted below.
 *
 * Copyright 2018 Astraea, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 *     [http://www.apache.org/licenses/LICENSE-2.0]
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package astraea.spark.rasterframes.jts

import java.sql.Timestamp
import java.time.ZonedDateTime

import astraea.spark.rasterframes.expressions.SpatialExpression.{Contains, Intersects}
import com.vividsolutions.jts.geom._
import geotrellis.util.MethodExtensions
import geotrellis.vector.{Point ⇒ gtPoint}
import org.apache.spark.sql.TypedColumn
import org.apache.spark.sql.functions._
import org.apache.spark.sql.rf.CanBeColumn

/**
 * Extension methods on typed columns allowing for DSL-like queries over JTS types.
 * @since 1/10/18
 */
trait Implicits extends SpatialFunctions {
  import astraea.spark.rasterframes.encoders.SparkDefaultEncoders._

  implicit class ExtentColumnMethods[T <: Geometry](val self: TypedColumn[Any, T])
    extends MethodExtensions[TypedColumn[Any, T]] {

    def intersects(geom: Geometry): TypedColumn[Any, Boolean] =
      Intersects(self.expr, geomLit(geom).expr).asColumn.as[Boolean]

    def intersects(pt: gtPoint): TypedColumn[Any, Boolean] =
      Intersects(self.expr, geomLit(pt.jtsGeom).expr).asColumn.as[Boolean]

    def containsGeom(geom: Geometry): TypedColumn[Any, Boolean] =
      Contains(self.expr, geomLit(geom).expr).asColumn.as[Boolean]

  }

  implicit class PointColumnMethods(val self: TypedColumn[Any, Point])
    extends MethodExtensions[TypedColumn[Any, Point]] {

    def intersects(geom: Geometry): TypedColumn[Any, Boolean] =
      Intersects(self.expr, geomLit(geom).expr).asColumn.as[Boolean]
   }

  implicit class TimestampColumnMethods(val self: TypedColumn[Any, Timestamp])
    extends MethodExtensions[TypedColumn[Any, Timestamp]] {

    import scala.language.implicitConversions
    private implicit def zdt2ts(time: ZonedDateTime): Timestamp =
      new Timestamp(time.toInstant.toEpochMilli)

    def betweenTimes(start: Timestamp, end: Timestamp): TypedColumn[Any, Boolean] =
      self.between(lit(start), lit(end)).as[Boolean]

    def betweenTimes(start: ZonedDateTime, end: ZonedDateTime): TypedColumn[Any, Boolean] =
      betweenTimes(start: Timestamp, end: Timestamp)

    def at(time: Timestamp): TypedColumn[Any, Boolean] = (self === lit(time)).as[Boolean]
    def at(time: ZonedDateTime): TypedColumn[Any, Boolean] = at(time: Timestamp)
  }
}

object Implicits extends Implicits