Class: Couchbase::SearchQuery::GeoPolygonQuery

Inherits:
SearchQuery
  • Object
show all
Defined in:
lib/couchbase/search_options.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/search_options.rb

Overview

A search query which allows to match inside a geo polygon.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(coordinates) {|self| ... } ⇒ GeoPolygonQuery

Returns a new instance of GeoPolygonQuery.

Parameters:

  • coordinates (Array<Coordinate>) —

    list of coordinates that forms polygon

Yield Parameters:



704
705
706
707
708
 
# File 'lib/couchbase/search_options.rb', line 704

def initialize(coordinates)
  super()
  @coordinates = coordinates
  yield self if block_given?
end

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 


696
697
698
 
# File 'lib/couchbase/search_options.rb', line 696

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 


699
700
701
 
# File 'lib/couchbase/search_options.rb', line 699

def field
  @field
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:



711
712
713
714
715
716
717
718
 
# File 'lib/couchbase/search_options.rb', line 711

def to_h
  data = {
    :polygon_points => @coordinates.map { |coord| [coord.longitude, coord.latitude] },
  }
  data[:boost] = boost if boost
  data[:field] = field if field
  data
end