Module: SearchSolrTools::Helpers::SolrFormat

Defined in:
lib/search_solr_tools/helpers/solr_format.rb

Overview

Methods for generating formatted values that can be indexed by SOLR

Constant Summary collapse

DATA_CENTER_NAMES = 
{
  NSIDC: { short_name: 'NSIDC', long_name: 'National Snow and Ice Data Center' }
}.freeze
NOT_SPECIFIED = 
'Not specified'
TEMPORAL_RESOLUTION_FACET_VALUES = 
%w[Subhourly Hourly Subdaily Daily Weekly Submonthly Monthly Subyearly Yearly Multiyearly].freeze
SUBHOURLY_INDEX = 
0
HOURLY_INDEX = 
1
SUBDAILY_INDEX = 
2
DAILY_INDEX = 
3
WEEKLY_INDEX = 
4
SUBMONTHLY_INDEX = 
5
MONTHLY_INDEX = 
6
SUBYEARLY_INDEX = 
7
YEARLY_INDEX = 
8
MULTIYEARLY_INDEX = 
9
SPATIAL_RESOLUTION_FACET_VALUES = 
['0 - 500 m', '501 m - 1 km', '2 - 5 km', '6 - 15 km', '16 - 30 km', '>30 km'].freeze
SPATIAL_0_500_INDEX = 
0
SPATIAL_501_1_INDEX = 
1
SPATIAL_2_5_INDEX = 
2
SPATIAL_6_15_INDEX = 
3
SPATIAL_16_30_INDEX = 
4
SPATIAL_GREATER_30_INDEX = 
5
REDUCE_TEMPORAL_DURATION = 
proc { |values| reduce_temporal_duration(values) }
DATE = 
proc { |date| date_str date.text }
HTTP_URL_FORMAT = 
proc do |url_node|
  url = url_node.text
  url =~ %r{//} ? url : "http://#{url}"
end
MIN_DATE = 
'00010101'
MAX_DATE = 
Time.now.strftime('%Y%m%d')

Class Method Summary collapse

Class Method Details

.bin(mappings, term) ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 161

def self.bin(mappings, term)
  mappings.each do |mapping|
    term.match(mapping['pattern']) do
      return mapping['mapping'].upcase
    end
  end
  nil
end

.date?(date) ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
239
240
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 235

def self.date?(date)
  return false unless date.is_a? String

  d = DateTime.parse(date.strip) rescue false
  DateTime.valid_date?(d.year, d.mon, d.day) unless d.eql?(false)
end

.date_str(date) ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 149

def self.date_str(date)
  d = if date.is_a? String
        DateTime.parse(date.strip) rescue nil
      else
        date
      end
  "#{d.iso8601[0..-7]}Z" unless d.nil?
end

.facet_binning(type, format_string) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 88

def self.facet_binning(type, format_string)
  binned_facet = bin(FacetConfiguration.get_facet_bin(type), format_string)
  if binned_facet.nil?
    format_string
  elsif binned_facet.match?(/\Aexclude\z/i)
    nil
  else
    binned_facet
  end
end

.find_index_for_single_spatial_resolution_value(string_duration) ⇒ Object 



190
191
192
193
194
195
196
197
198
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 190

def self.find_index_for_single_spatial_resolution_value(string_duration)
  value, units = string_duration.split

  if units == 'deg'
    spatial_resolution_index_degrees(value)
  elsif units == 'm'
    spatial_resolution_index_meters(value)
  end
end

.find_index_for_single_temporal_resolution_value(string_duration) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 170

def self.find_index_for_single_temporal_resolution_value(string_duration)
  iso8601_duration = ISO8601::Duration.new(string_duration)

  dur_sec = iso8601_duration.to_seconds

  case dur_sec
  when 0..3_599              then SUBHOURLY_INDEX
  when 3600                  then HOURLY_INDEX
  when 3601..86_399          then SUBDAILY_INDEX
  when 86_400..172_800       then DAILY_INDEX
  when 172_801..691_200      then WEEKLY_INDEX
  when 691_201..1_728_000    then SUBMONTHLY_INDEX
  when 1_728_001..2_678_400  then MONTHLY_INDEX
  when 2_678_400..31_535_999 then SUBYEARLY_INDEX
  when 31_536_000            then YEARLY_INDEX
  else
    MULTIYEARLY_INDEX
  end
end

.format_date_for_index(date_str, default) ⇒ Object 



242
243
244
245
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 242

def self.format_date_for_index(date_str, default)
  date_str = default unless date? date_str
  DateTime.parse(date_str).strftime('%C.%y%m%d')
end

.get_spatial_scope_facet_with_bounding_box(bbox) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 135

def self.get_spatial_scope_facet_with_bounding_box(bbox)
  if bbox.nil? || BoundingBoxUtil.box_invalid?(bbox)
    return nil
  elsif BoundingBoxUtil.box_global?(bbox)
    facet = 'Coverage from over 85 degrees North to -85 degrees South | Global'
  elsif BoundingBoxUtil.box_local?(bbox)
    facet = 'Less than 1 degree of latitude change | Local'
  else
    facet = 'Between 1 and 170 degrees of latitude change | Regional'
  end

  facet
end

.get_temporal_duration(start_time, end_time) ⇒ Object

returns the temporal duration in days; returns -1 if there is not a valid start date



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 55

def self.get_temporal_duration(start_time, end_time)
  if start_time.to_s.empty?
    duration = nil
  else
    end_time = Time.now if end_time.to_s.empty?
    # datasets that cover just one day would have end_date - start_date = 0,
    # so we need to add 1 to make sure the duration is the actual number of
    # days; if the end date and start date are flipped in the metadata, a
    # negative duration doesn't make sense so use the absolute value
    duration = Integer((end_time - start_time).abs / 86_400) + 1
  end
  duration
end

.get_temporal_duration_facet(duration) ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 69

def self.get_temporal_duration_facet(duration)
  return NOT_SPECIFIED if duration.nil?

  years = duration.to_i / 365
  temporal_duration_range(years)
end

.parameter_binning(parameter_string) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 99

def self.parameter_binning(parameter_string)
  binned_parameter = bin(FacetConfiguration.get_facet_bin('parameter'), parameter_string)
  return binned_parameter unless binned_parameter.nil?

  # if no mapping exists, use variable_level_1.
  # Force it to all upper case for consistency. This is a hacky workaround to
  # deal with deprecated GCMD keywords still in use by some datasets that result
  # in duplicate, case-sensitive entries in the search interface facet list.
  parts = parameter_string.split '>'
  return parts[3].strip.upcase if parts.length >= 4

  nil
end

.reduce_temporal_duration(values) ⇒ Object 



84
85
86
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 84

def self.reduce_temporal_duration(values)
  values.map { |v| Integer(v) rescue nil }.compact.max
end

.resolution_not_specified?(resolution) ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
131
132
133
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 128

def self.resolution_not_specified?(resolution)
  return true if resolution.to_s.empty?
  return true unless %w[single range].include? resolution['type']
  return true if resolution['type'] == 'single' && resolution['resolution'].to_s.empty?
  return true if resolution['type'] == 'range' && resolution['min_resolution'].to_s.empty?
end

.resolution_value(resolution, find_index_method, resolution_values) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 113

def self.resolution_value(resolution, find_index_method, resolution_values)
  return NOT_SPECIFIED if resolution_not_specified? resolution

  if resolution['type'] == 'single'
    i = send(find_index_method, resolution['resolution'])
    return resolution_values[i]
  end
  if resolution['type'] == 'range'
    i = send(find_index_method, resolution['min_resolution'])
    j = send(find_index_method, resolution['max_resolution'])
    return resolution_values[i..j]
  end
  raise "Invalid resolution #{resolution['type']}"
end

.spatial_resolution_index_degrees(degrees) ⇒ Object 



200
201
202
203
204
205
206
207
208
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 200

def self.spatial_resolution_index_degrees(degrees)
  if degrees.to_f <= 0.05
    SPATIAL_2_5_INDEX
  elsif degrees.to_f < 0.5
    SPATIAL_16_30_INDEX
  else
    SPATIAL_GREATER_30_INDEX
  end
end

.spatial_resolution_index_meters(meters) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 210

def self.spatial_resolution_index_meters(meters)
  case meters.to_f
  when 0..500 then SPATIAL_0_500_INDEX
  when 500..1_000 then SPATIAL_501_1_INDEX
  when 1_000..5_000 then SPATIAL_2_5_INDEX
  when 5_000..15_000 then SPATIAL_6_15_INDEX
  when 15_000..30_000 then SPATIAL_16_30_INDEX
  else
    SPATIAL_GREATER_30_INDEX
  end
end

.temporal_display_str(date_range) ⇒ Object 



47
48
49
50
51
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 47

def self.temporal_display_str(date_range)
  temporal_str = (date_range[:start]).to_s
  temporal_str += ",#{date_range[:end]}" unless date_range[:end].nil?
  temporal_str
end

.temporal_duration_range(years) ⇒ Object

takes a temporal_duration in years, returns a string representing the range for faceting



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 224

def self.temporal_duration_range(years)
  range = []

  range.push '< 1 year' if years >= 0 && years < 1
  range.push '1+ years' if years >= 1
  range.push '5+ years' if years >= 5
  range.push '10+ years' if years >= 10

  range
end

.temporal_index_str(date_range) ⇒ Object

We are indexing date ranges a spatial coordinates. This means we have to convert dates into the format YY.YYMMDD which can be stored in the standard lat/long space For example: 2013-01-01T00:00:00Z to 2013-01-31T00:00:00Z will be converted to 20.130101, 20.130131. See wiki.apache.org/solr/SpatialForTimeDurations



80
81
82
 
# File 'lib/search_solr_tools/helpers/solr_format.rb', line 80

def self.temporal_index_str(date_range)
  "#{format_date_for_index date_range[:start], MIN_DATE} #{format_date_for_index(date_range[:end], MAX_DATE)}"
end