Class: CocinaDisplay::Geospatial::Point

Inherits:
Coordinates show all
Defined in:
lib/cocina_display/geospatial.rb

Overview

A single geospatial point with latitude and longitude.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Coordinates

from_cocina, from_structured_values, parse

Constructor Details

#initialize(point) ⇒ Point

Construct a Point from a single Geo::Coord point.

Parameters:

  • point (Geo::Coord) 


136
137
138
 
# File 'lib/cocina_display/geospatial.rb', line 136

def initialize(point)
  @point = point
end

Instance Attribute Details

#point ⇒ Object (readonly)

Returns the value of attribute point.



121
122
123
 
# File 'lib/cocina_display/geospatial.rb', line 121

def point
  @point
end

Class Method Details

.from_coords(lat:, lng:) ⇒ Point?

Construct a Point from latitude and longitude string values.

Parameters:

  • lat (String) —

    latitude

  • lng (String) —

    longitude

Returns:

  • (Point, nil) —

    nil if parsing fails



127
128
129
130
131
132
 
# File 'lib/cocina_display/geospatial.rb', line 127

def self.from_coords(lat:, lng:)
  point = Geo::Coord.parse("#{lat}, #{lng}")
  return unless point

  new(point)
end

Instance Method Details

#as_bbox ⇒ nil

Note:

This is impossible for a single point; we always return nil.

Format as a bounding box.

Returns:

  • (nil) 


168
169
170
 
# File 'lib/cocina_display/geospatial.rb', line 168

def as_bbox
  nil
end

#as_envelope ⇒ nil

Note:

This is impossible for a single point; we always return nil.

Format using the CQL ENVELOPE representation.

Returns:

  • (nil) 


161
162
163
 
# File 'lib/cocina_display/geospatial.rb', line 161

def as_envelope
  nil
end

#as_point ⇒ String

Note:

Limits decimals to 6 places.

Format as a space-separated x y (longitude latitude) pair.

Examples:

"-118.2437 34.0522"

Returns:

  • (String) 


176
177
178
 
# File 'lib/cocina_display/geospatial.rb', line 176

def as_point
  "%.6f %.6f" % [point.lng, point.lat]
end

#as_wkt ⇒ String

Note:

Limits decimals to 6 places.

Format using the Well-Known Text (WKT) representation.

Examples:

"POINT(-118.2437 34.0522)"

Returns:

  • (String)

See Also:



154
155
156
 
# File 'lib/cocina_display/geospatial.rb', line 154

def as_wkt
  "POINT(%.6f %.6f)" % [point.lng, point.lat]
end

#to_s ⇒ String

Note:

This format adapts the "Annex D" human representation style.

Format for display in DMS format, adapted from ISO 6709 standard.

Examples:

"34°03′08″N 118°14′37″W"

Returns:

  • (String)

See Also:



145
146
147
 
# File 'lib/cocina_display/geospatial.rb', line 145

def to_s
  format_point(point).join(" ")
end