Class: Queries::Otu::Filter

Inherits:
Query::Filter show all
Includes:
Concerns::Citations, Concerns::Confidences, Concerns::Conveyances, Concerns::DataAttributes, Concerns::Depictions, Concerns::Geo, Concerns::Notes, Concerns::Sounds, Concerns::Tags, Helpers
Defined in:
lib/queries/otu/filter.rb

Constant Summary collapse

PARAMS = 
[
  :ancestrify,
  :asserted_distributions,
  :biological_association_id,
  :biological_associations,
  :biological_relationship_id,
  :exclude_taxon_name_relationship,
  :collecting_event_id,
  :collection_objects,
  :common_names,
  :contents,
  :coordinatify,
  :descendants,
  :descriptor_id,
  :geo_shape_id,
  :geo_mode,
  :geo_shape_type,
  :geo_json,
  :name,
  :name_exact,
  :observations,
  :otu_id,
  :radius,
  :taxon_name,
  :taxon_name_id,
  :dwc_occurrences,
  :with_name,
  :wkt,

  biological_relationship_id: [],
  collecting_event_id: [],
  descriptor_id: [],
  geo_shape_id: [],
  geo_shape_type: [],
  name: [],
  otu_id: [],
  taxon_name_id: [],
].freeze

Constants inherited from Query::Filter

Query::Filter::FILTER_QUERIES, Query::Filter::SUBQUERIES

Instance Attribute Summary collapse

Attributes inherited from Query::Filter

#anatomical_part_query, #api, #asserted_distribution_query, #biological_association_query, #biological_associations_graph_query, #collecting_event_query, #collection_object_query, #content_query, #controlled_vocabulary_term_query, #conveyance_query, #data_attribute_query, #depiction_query, #descriptor_query, #document_query, #dwc_occurrence_query, #extract_query, #field_occurrence_query, #image_query, #loan_query, #object_global_id, #observation_query, #order_by, #otu_query, #page, #paginate, #params, #per, #person_query, #project_id, #recent, #recent_target, #roll_call, #sound_query, #taxon_name_query, #taxon_name_relationship_query, #venn, #venn_ignore_pagination, #venn_mode

Attributes inherited from Query

#query_string, #terms

Instance Method Summary collapse

Methods included from Helpers

#boolean_param, #integer_param, #split_pairs, #split_repeated_pairs, #tri_value_array

Methods inherited from Query::Filter

#all_and_clauses, #all_merge_clauses, #annotator_and_clauses, #annotator_merge_clauses, annotator_params, api_except_params, api_excluded_params, #apply_venn, #attribute_exact_facet, base_filter, base_query_name, base_query_to_h, #deep_permit, #disable_paging, included_annotator_facets, instantiated_base_filter, inverted_subqueries, #model_id_facet, #object_global_id_facet, #only_project?, #only_project_or_less?, #paging_state, params, #permitted_params, #process_url_into_params, #project_id_facet, query_name, #set_nested_queries, #set_paging, set_paging, #shared_and_clauses, #subquery_vector, #target_and_clauses, #venn_query

Methods inherited from Query

#alphabetic_strings, #alphanumeric_strings, base_name, #base_name, #base_query, #build_terms, #cached_facet, #end_wildcard, #levenshtein_distance, #match_ordered_wildcard_pieces_in_cached, #no_terms?, referenced_klass, #referenced_klass, #referenced_klass_except, #referenced_klass_intersection, #referenced_klass_union, #start_and_end_wildcard, #start_wildcard, #table, #wildcard_pieces

Constructor Details

#initialize(query_params) ⇒ Filter

Returns a new instance of Filter.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/queries/otu/filter.rb', line 202

def initialize(query_params)
  super

  @ancestrify = boolean_param(params, :ancestrify)
  @asserted_distributions = boolean_param(params, :asserted_distributions)
  @biological_association_id = params[:biological_association_id]
  @biological_associations = boolean_param(params, :biological_associations)
  @biological_relationship_id = params[:biological_relationship_id]
  @exclude_taxon_name_relationship = boolean_param(params, :exclude_taxon_name_relationship)
  @collecting_event_id = params[:collecting_event_id]
  @collection_objects = boolean_param(params, :collection_objects)
  @common_names = boolean_param(params, :common_names)
  @contents = boolean_param(params, :contents)
  @coordinatify = boolean_param(params, :coordinatify)
  @descendants = boolean_param(params, :descendants)
  @dwc_occurrences = boolean_param(params, :dwc_occurrences)
  @descriptor_id = params[:descriptor_id]
  @geo_json = params[:geo_json]
  @historical_determinations = boolean_param(params, :historical_determinations)
  @name = params[:name]
  @name_exact = boolean_param(params, :name_exact)
  @observations = boolean_param(params, :observations)
  @otu_id = params[:otu_id]
  @radius = params[:radius].presence || 100.0
  @taxon_name = boolean_param(params, :taxon_name)
  @taxon_name_id = params[:taxon_name_id]
  @with_name = boolean_param(params, :with_name)
  @wkt = params[:wkt]

  set_confidences_params(params)
  set_conveyance_params(params)
  set_notes_params(params)
  set_citations_params(params)
  set_depiction_params(params)
  set_data_attributes_params(params)
  set_tags_params(params)
  set_geo_params(params)
end

Instance Attribute Details

#ancestrify ⇒ Object

!! This param is not like the others. !! See parallel in TaxonName filter 'ancestrify'.

Returns:

  • Boolean if true then, additionally, all coordinate otus for all inferred ancestors are included the param adds to the result by going "up" (to root) then "out"



60
61
62
 
# File 'lib/queries/otu/filter.rb', line 60

def ancestrify
  @ancestrify
end

#asserted_distributions ⇒ True, ...

Returns true - Otu has AssertedDistribution false - Otu without AssertedDistribution nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has AssertedDistribution false - Otu without AssertedDistribution nil - not applied



160
161
162
 
# File 'lib/queries/otu/filter.rb', line 160

def asserted_distributions
  @asserted_distributions
end

#biological_association_id ⇒ Object

Finds all OTUs that are the current determination of a CollectionObject that is in the BiologicalAssociation or are part of the Biological association itself. Altered by historical_determinations.

Parameters:

  • biological_association_id (Integer, Array)

Returns:

  • Array one or more biological_association_id



123
124
125
 
# File 'lib/queries/otu/filter.rb', line 123

def biological_association_id
  @biological_association_id
end

#biological_associations ⇒ True, ...

Returns true - Otu has BiologicalAssocation (subject or object) false - Otu without BiologicalAssociation nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has BiologicalAssocation (subject or object) false - Otu without BiologicalAssociation nil - not applied



184
185
186
 
# File 'lib/queries/otu/filter.rb', line 184

def biological_associations
  @biological_associations
end

#biological_relationship_id ⇒ Object

Finds all OTUs that are related to a BiologicalAssociation with the given BiologicalRelationship. See also exclude_taxon_name_relationship.

Parameters:

  • biological_relationship_id (Integer, Array)

Returns:

  • Array one or more biological_relationship_id



131
132
133
 
# File 'lib/queries/otu/filter.rb', line 131

def biological_relationship_id
  @biological_relationship_id
end

#collecting_event_id ⇒ Object

Finds all OTUs that are the current determination of a CollectionObject that was collecting in these Collecting events. Altered by historical_determinations.

Parameters:

  • collecting_event_id (Integer, Array)

Returns:

  • Array one or more collecting_event_id



105
106
107
 
# File 'lib/queries/otu/filter.rb', line 105

def collecting_event_id
  @collecting_event_id
end

#collection_objects ⇒ True, ...

Returns true - Otu has CollectionObjects false - Otu without CollectionObjects nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has CollectionObjects false - Otu without CollectionObjects nil - not applied



178
179
180
 
# File 'lib/queries/otu/filter.rb', line 178

def collection_objects
  @collection_objects
end

#common_names ⇒ True, ...

Returns true - Otu has common names false - Otu without common names nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has common names false - Otu without common names nil - not applied



166
167
168
 
# File 'lib/queries/otu/filter.rb', line 166

def common_names
  @common_names
end

#contents ⇒ True, ...

Returns true - Otu has Content false - Otu without Content nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has Content false - Otu without Content nil - not applied



172
173
174
 
# File 'lib/queries/otu/filter.rb', line 172

def contents
  @contents
end

#coordinatify ⇒ Object

See coordinatify_result for more.

!! This param is not like the others. !! See parallel in TaxonName filter 'validify'.

Returns:

  • Boolean if true then, additionally, all coordinate otus for the result are included



68
69
70
 
# File 'lib/queries/otu/filter.rb', line 68

def coordinatify
  @coordinatify
end

#descendants ⇒ Object

Returns Boolean.

Returns:

  • Boolean



96
97
98
 
# File 'lib/queries/otu/filter.rb', line 96

def descendants
  @descendants
end

#descriptor_id ⇒ Array

Parameters:

  • descriptor_id (String, Array)

Returns:

  • (Array) 


154
155
156
 
# File 'lib/queries/otu/filter.rb', line 154

def descriptor_id
  @descriptor_id
end

#dwc_occurrences ⇒ True, ...

Returns true - Otu is linked to one or more DwcOccurrences (via CollectionObject, FieldOccurrence, or AssertedDistribution) false - Otu has no DwcOccurrences nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu is linked to one or more DwcOccurrences (via CollectionObject, FieldOccurrence, or AssertedDistribution) false - Otu has no DwcOccurrences nil - not applied



190
191
192
 
# File 'lib/queries/otu/filter.rb', line 190

def dwc_occurrences
  @dwc_occurrences
end

#exclude_taxon_name_relationship ⇒ Object

When true, finds OTUs that are NOT related to a BiologicalAssociation with any of the given biological_relationship_id values.

Parameters:

  • exclude_taxon_name_relationship (Boolean) 


136
137
138
 
# File 'lib/queries/otu/filter.rb', line 136

def exclude_taxon_name_relationship
  @exclude_taxon_name_relationship
end

#geo_json ⇒ Hash?

Returns in geo_json format (no Feature ...) ?!.

Returns:

  • (Hash, nil) —

    in geo_json format (no Feature ...) ?!



144
145
146
 
# File 'lib/queries/otu/filter.rb', line 144

def geo_json
  @geo_json
end

#historical_determinations ⇒ Boolean?

Where applicable:

true - include only historical determinations (ignores only determinations)
false - include both current and historical
nil - include only current determinations

Impacts all TaxonDetermination referencing queries

Parameters:

  • historical_determinations (Boolean)

Returns:

  • (Boolean, nil) 


114
115
116
 
# File 'lib/queries/otu/filter.rb', line 114

def historical_determinations
  @historical_determinations
end

#name ⇒ Object

Returns Array literal match against one or more Otu#name.

Parameters:

  • name (String, Array)

Returns:

  • Array literal match against one or more Otu#name



73
74
75
 
# File 'lib/queries/otu/filter.rb', line 73

def name
  @name
end

#name_exact ⇒ Object

Returns Boolean if true then match on name exactly.

Returns:

  • Boolean if true then match on name exactly



77
78
79
 
# File 'lib/queries/otu/filter.rb', line 77

def name_exact
  @name_exact
end

#observations ⇒ True, ...

Returns true - Otu has observations false - Otu without observations nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has observations false - Otu without observations nil - not applied



196
197
198
 
# File 'lib/queries/otu/filter.rb', line 196

def observations
  @observations
end

#otu_id ⇒ Object

Returns Array one or more Otu ids.

Parameters:

  • otu_id (Integer, Array)

Returns:

  • Array one or more Otu ids



88
89
90
 
# File 'lib/queries/otu/filter.rb', line 88

def otu_id
  @otu_id
end

#radius ⇒ Object

Integer in Meters !! defaults to 100m



200
201
202
 
# File 'lib/queries/otu/filter.rb', line 200

def radius
  @radius
end

#taxon_name ⇒ True, ...

Returns true - Otu has taxon name false - Otu without taxon name nil - not applied.

Returns:

  • (True, False, nil) —

    true - Otu has taxon name false - Otu without taxon name nil - not applied



150
151
152
 
# File 'lib/queries/otu/filter.rb', line 150

def taxon_name
  @taxon_name
end

#taxon_name_id ⇒ Object

Returns Array one or more Otu taxon_name_id.

Parameters:

  • taxon_name_id (Integer, Array)

Returns:

  • Array one or more Otu taxon_name_id



93
94
95
 
# File 'lib/queries/otu/filter.rb', line 93

def taxon_name_id
  @taxon_name_id
end

#with_name ⇒ Object

Returns Boolean true - has name false - has no name nil - both.

Returns:

  • Boolean true - has name false - has no name nil - both



83
84
85
 
# File 'lib/queries/otu/filter.rb', line 83

def with_name
  @with_name
end

#wkt ⇒ Object

Parameters:

  • wkt (String) —

    A Spatial area in WKT format



140
141
142
 
# File 'lib/queries/otu/filter.rb', line 140

def wkt
  @wkt
end

Instance Method Details

#all(nil_empty = false) ⇒ ActiveRecord::Relation

Returns:

  • (ActiveRecord::Relation) 


825
826
827
828
829
830
831
832
833
 
# File 'lib/queries/otu/filter.rb', line 825

def all(nil_empty = false)
  q = super

  # Order matters, coordinatify should be last as its "out"
  q = ancestrify_result(q) if ancestrify
  q = coordinatify_result(q) if coordinatify

  q
end

#anatomical_part_query_facet ⇒ Object 



691
692
693
694
695
696
697
 
# File 'lib/queries/otu/filter.rb', line 691

def anatomical_part_query_facet
  return nil if anatomical_part_query.nil?

  ::Otu
    .joins(:origin_relationships)
    .where("origin_relationships.new_object_id IN (#{ anatomical_part_query.all.select(:id).to_sql })")
end

#ancestrify_result(q) ⇒ Object 



767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/queries/otu/filter.rb', line 767

def ancestrify_result(q)
  a = q

  s = 'WITH otu_base AS (' + a.all.to_sql + ') ' +
    ::Otu
    .joins('JOIN taxon_name_hierarchies tnh on tnh.ancestor_id = otus.taxon_name_id')
    .joins('JOIN otu_base as otu_base1 on otu_base1.taxon_name_id = tnh.descendant_id')
    .to_sql

  b = ::Otu.from('(' + s + ') as otus')

  referenced_klass_union([a, b])
end

#and_clauses ⇒ Object 



781
782
783
784
785
786
 
# File 'lib/queries/otu/filter.rb', line 781

def and_clauses
  [
    name_facet,
    taxon_name_facet,
  ]
end

#asserted_distribution_query_facet ⇒ Object 



563
564
565
566
567
568
 
# File 'lib/queries/otu/filter.rb', line 563

def asserted_distribution_query_facet
  return nil if asserted_distribution_query.nil?
  ::Otu
    .with(ad: asserted_distribution_query.all)
    .joins("JOIN ad ON ad.asserted_distribution_object_id = otus.id AND ad.asserted_distribution_object_type = 'Otu'").distinct
end

#asserted_distributions_facet ⇒ Object 



350
351
352
353
354
355
356
357
 
# File 'lib/queries/otu/filter.rb', line 350

def asserted_distributions_facet
  return nil if asserted_distributions.nil?
  if asserted_distributions
    ::Otu.joins(:asserted_distributions).distinct
  else
    ::Otu.where.missing(:asserted_distributions)
  end
end

#biological_association_id_facet ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/queries/otu/filter.rb', line 447

def biological_association_id_facet
  return nil if biological_association_id.empty?

  q1 = ::Otu.joins(:biological_associations).where(biological_associations: { id: biological_association_id, biological_association_subject_type: 'Otu' })
  q2 = ::Otu.joins(:related_biological_associations).where(related_biological_associations: { id: biological_association_id, biological_association_object_type: 'Otu' })
  q3 = ::Otu.joins(collection_objects: [:biological_associations]).where(biological_associations: { id: biological_association_id, biological_association_subject_type: 'CollectionObject' })
  q4 = ::Otu.joins(collection_objects: [:related_biological_associations]).where(related_biological_associations: { id: biological_association_id, biological_association_object_type: 'CollectionObject' })

  if historical_determinations.nil?
    q3 = q3.where(taxon_determinations: { position: 1 })
    q4 = q4.where(taxon_determinations: { position: 1 })
  elsif historical_determinations
    q3 = q3.where.not(taxon_determinations: { position: 1 })
    q4 = q4.where.not(taxon_determinations: { position: 1 })
  end

  query = referenced_klass_union([q1, q2, q3, q4])

  ::Otu.from("(#{query.to_sql}) as otus").distinct
end

#biological_association_query_facet ⇒ Object 



580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/queries/otu/filter.rb', line 580

def biological_association_query_facet
  return nil if biological_association_query.nil?
  s = 'WITH query_ba_otu AS (' + biological_association_query.all.to_sql + ') '

  a = ::Otu
    .joins("JOIN query_ba_otu as query_ba_otu1 on otus.id = query_ba_otu1.biological_association_subject_id AND query_ba_otu1.biological_association_subject_type = 'Otu'")

  b = ::Otu
    .joins("JOIN query_ba_otu as query_ba_otu2 on otus.id = query_ba_otu2.biological_association_object_id AND query_ba_otu2.biological_association_object_type = 'Otu'")

  s << referenced_klass_union([a, b]).to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#biological_associations_facet ⇒ Object

UNION, NOT EXISTS example



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/queries/otu/filter.rb', line 388

def biological_associations_facet
  return nil if biological_associations.nil?

  a = ::Otu.joins(:biological_associations)
  b = ::Otu.joins(:related_biological_associations)

  c = ::Otu.from("((#{a.to_sql}) UNION (#{b.to_sql})) as otus")

  if biological_associations
    ::Otu.from("((#{a.to_sql}) UNION (#{b.to_sql})) as otus")
  else
    ::Otu.where('NOT EXISTS (' + ::Otu.select('1').from( # not exists ( a select(1) from <opposite query>  )
                                                        ::Otu.from(
                                                          "((#{a.to_sql}) UNION (#{b.to_sql})) as ba_otus_join"
                                                        ).where('otus.id = ba_otus_join.id')
                                                       ).to_sql + ')')  # where includes in/out link
  end
end

#biological_associations_table ⇒ Object 



241
242
243
 
# File 'lib/queries/otu/filter.rb', line 241

def biological_associations_table
  ::BiologicalAssociation.arel_table
end

#biological_relationship_id_facet ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/queries/otu/filter.rb', line 468

def biological_relationship_id_facet
  return nil if biological_relationship_id.empty?

  q1 = ::Otu.joins(:biological_associations)
    .where(biological_associations: { biological_relationship_id:, biological_association_subject_type: 'Otu' })

  q2 = ::Otu.joins(:related_biological_associations)
    .where(related_biological_associations: { biological_relationship_id: })

  q3 = ::Otu.joins(collection_objects: [:biological_associations])
    .where(biological_associations: { biological_relationship_id:, biological_association_subject_type: 'CollectionObject' })
    .where(taxon_determinations: { position: 1 })

  q4 = ::Otu.joins(collection_objects: [:related_biological_associations])
    .where(related_biological_associations: { biological_relationship_id: })
    .where(taxon_determinations: { position: 1 })

  q5 = ::Otu.joins(field_occurrences: [:biological_associations])
    .where(biological_associations: { biological_relationship_id:, biological_association_subject_type: 'FieldOccurrence' })
    .where(taxon_determinations: { position: 1 })

  q6 = ::Otu.joins(field_occurrences: [:related_biological_associations])
    .where(related_biological_associations: { biological_relationship_id: })
    .where(taxon_determinations: { position: 1 })

  q7 = ::Otu.joins(anatomical_parts: [:biological_associations])
    .where(biological_associations: { biological_relationship_id:, biological_association_subject_type: 'AnatomicalPart' })

  q8 = ::Otu.joins(anatomical_parts: [:related_biological_associations])
    .where(related_biological_associations: { biological_relationship_id: })

  matched = ::Otu.from("(#{referenced_klass_union([q1, q2, q3, q4, q5, q6, q7, q8]).to_sql}) as otus").distinct

  if exclude_taxon_name_relationship
    ::Otu.where.not(id: matched)
  else
    matched
  end
end

#collecting_event_id_facet ⇒ Object 



436
437
438
439
440
441
442
443
444
445
 
# File 'lib/queries/otu/filter.rb', line 436

def collecting_event_id_facet
  return nil if collecting_event_id.empty?
  if historical_determinations.nil?
    ::Otu.joins(:collection_objects).where(collection_objects: { collecting_event_id: }, taxon_determinations: { position: 1 }).distinct
  elsif historical_determinations
    ::Otu.joins(:collection_objects).where(collection_objects: { collecting_event_id: }).where.not(taxon_determinations: { position: 1 }).distinct
  else
    ::Otu.joins(:collection_objects).where(collection_objects: { collecting_event_id: })
  end
end

#collecting_event_query_facet ⇒ Object 



617
618
619
620
621
622
623
624
625
626
 
# File 'lib/queries/otu/filter.rb', line 617

def collecting_event_query_facet
  return nil if collecting_event_query.nil?
  s = 'WITH query_ce_otus AS (' + collecting_event_query.all.to_sql + ') ' +
    ::Otu
    .joins(:collecting_events)
    .joins('JOIN query_ce_otus as query_ce_otus1 on collecting_events.id = query_ce_otus1.id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#collection_object_query_facet ⇒ Object 



595
596
597
598
599
600
601
602
603
604
 
# File 'lib/queries/otu/filter.rb', line 595

def collection_object_query_facet
  return nil if collection_object_query.nil?
  s = 'WITH query_co_otus AS (' + collection_object_query.all.to_sql + ') ' +
    ::Otu
    .joins(:collection_objects)
    .joins('JOIN query_co_otus as query_co_otus1 on collection_objects.id = query_co_otus1.id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#collection_objects_facet ⇒ Object 



407
408
409
410
411
412
413
414
 
# File 'lib/queries/otu/filter.rb', line 407

def collection_objects_facet
  return nil if collection_objects.nil?
  if collection_objects
    ::Otu.joins(:collection_objects).distinct
  else
    ::Otu.where.missing(:collection_objects)
  end
end

#common_names_facet ⇒ Object 



377
378
379
380
381
382
383
384
385
 
# File 'lib/queries/otu/filter.rb', line 377

def common_names_facet
  return nil if @common_names.nil?

  if @common_names
    ::Otu.joins(:common_names).distinct
  else
    ::Otu.where.missing(:common_names)
  end
end

#content_query_facet ⇒ Object 



570
571
572
573
574
575
576
577
578
 
# File 'lib/queries/otu/filter.rb', line 570

def content_query_facet
  return nil if content_query.nil?
  s = 'WITH query_con_otus AS (' + content_query.all.to_sql + ') ' +
    ::Otu
    .joins('JOIN query_con_otus as query_con_otus1 on otus.id = query_con_otus1.otu_id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#contents_facet ⇒ Object 



368
369
370
371
372
373
374
375
 
# File 'lib/queries/otu/filter.rb', line 368

def contents_facet
  return nil if contents.nil?
  if contents
    ::Otu.joins(:contents).distinct
  else
    ::Otu.where.missing(:contents)
  end
end

#coordinatify_result(q) ⇒ Object

Expands result of OTU filter query in 2 ways: 1 - to include all valid OTUs by (proxy of TaxonName) if OTU is by proxy invalid 2 - to include all invalid OTUS (by proxy of TaxonName) if OTU is by proxy valid

In essence this creates full sets of TaxonConcepts from partial results. The result can be used to, for example, get a comprehensive list of Sources for the concept, or a comprehensive historical list of Specimens, etc.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/queries/otu/filter.rb', line 741

def coordinatify_result(q)

  i = q.joins(:taxon_name).where('taxon_names.id != taxon_names.cached_valid_taxon_name_id').where(project_id:)
  v = q.joins(:taxon_name).where('taxon_names.id = taxon_names.cached_valid_taxon_name_id').where(project_id:)

  # Find all valids related to a q-invalid
  s = 'WITH invalid_otu_result AS (' + i.to_sql + ') ' +
    ::Otu
    .joins('JOIN taxon_names tn1 on otus.taxon_name_id = tn1.cached_valid_taxon_name_id')
    .joins('JOIN invalid_otu_result AS invalid_otu_result1 ON invalid_otu_result1.taxon_name_id = tn1.id') # invalid otus matching valid names
    .to_sql

  a = ::Otu.from('(' + s + ') as otus')

  # Find all invalids related to a q-valid
  t = 'WITH valid_otu_result AS (' + v.to_sql + ') ' +
    ::Otu
    .joins('JOIN taxon_names tn2 on otus.taxon_name_id = tn2.id')
    .joins('JOIN valid_otu_result AS valid_otu_result1 ON valid_otu_result1.taxon_name_id = tn2.cached_valid_taxon_name_id') # valid otus matching invalid names
    .to_sql

  b = ::Otu.from('(' + t + ') as otus')

  referenced_klass_union([a, b, q])
end

#descriptor_id_facet ⇒ Object 



554
555
556
557
558
559
560
561
 
# File 'lib/queries/otu/filter.rb', line 554

def descriptor_id_facet
  return nil if descriptor_id.empty?

  q1 = ::Otu.joins(:descriptors).where(descriptors: { id: descriptor_id })
  q2 = ::Otu.joins(collection_objects: [:descriptors]).where(descriptors: { id: descriptor_id })

  referenced_klass_union([q1, q2]).distinct
end

#descriptor_query_facet ⇒ Object 



650
651
652
653
654
655
656
657
658
659
 
# File 'lib/queries/otu/filter.rb', line 650

def descriptor_query_facet
  return nil if descriptor_query.nil?
  s = 'WITH query_de_otus AS (' + descriptor_query.all.to_sql + ') ' +
    ::Otu
    .joins(:observations)
    .joins('JOIN query_de_otus as query_de_otus1 on observations.descriptor_id = query_de_otus1.id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#dwc_occurrence_query_facet ⇒ Object

!! This is a soft-link (i.e. no otu_id FK directly), so latency between indexing has a very small proability !! of impacting the results.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/queries/otu/filter.rb', line 712

def dwc_occurrence_query_facet
  return nil if dwc_occurrence_query.nil?

  a = dwc_occurrence_query.all.object_join('CollectionObject').select(dwc_occurrences: [:dwc_occurrence_object_id])
  b = dwc_occurrence_query.all.object_join('AssertedDistribution').select(dwc_occurrences: [:dwc_occurrence_object_id])
  c = dwc_occurrence_query.all.object_join('FieldOccurrence').select(dwc_occurrences: [:dwc_occurrence_object_id])

  d = ::Otu.with(co: a)
        .joins(:taxon_determinations).where(taxon_determinations: {position: 1})
        .joins('JOIN co on co.dwc_occurrence_object_id = taxon_determinations.taxon_determination_object_id')

  e = ::Otu.with(ad: b)
        .joins(:asserted_distributions)
        .joins('JOIN ad on ad.dwc_occurrence_object_id = asserted_distributions.id')

  f = ::Otu.with(fo: c)
        .joins(:taxon_determinations).where(taxon_determinations: {position: 1})
        .joins('JOIN fo on fo.dwc_occurrence_object_id = taxon_determinations.taxon_determination_object_id')

  ::Queries.union(::Otu, [d,e,f])
end

#dwc_occurrences_facet ⇒ Object 



698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/queries/otu/filter.rb', line 698

def dwc_occurrences_facet
  return nil if @dwc_occurrences.nil?

  q = ::Otu.where(id: ::DwcOccurrence.select(:otu_id).where.not(otu_id: nil))

  if @dwc_occurrences
    q
  else
    ::Otu.where.not(id: q.select(:id))
  end
end

#extract_query_facet ⇒ Object 



628
629
630
631
632
633
634
635
636
637
 
# File 'lib/queries/otu/filter.rb', line 628

def extract_query_facet
  return nil if extract_query.nil?
  s = 'WITH query_ex_otus AS (' + extract_query.all.to_sql + ') ' +
    ::Otu
    .joins(:origin_relationships)
    .joins("JOIN query_ex_otus as query_ex_otus1 on origin_relationships.new_object_id = query_ex_otus1.id and origin_relationships.new_object_type = 'Extract'")
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#field_occurrence_query_facet ⇒ Object 



606
607
608
609
610
611
612
613
614
615
 
# File 'lib/queries/otu/filter.rb', line 606

def field_occurrence_query_facet
  return nil if field_occurrence_query.nil?
  s = 'WITH query_fo_otus AS (' + field_occurrence_query.all.to_sql + ') ' +
    ::Otu
    .joins(:field_occurrences)
    .joins('JOIN query_fo_otus as query_fo_otus1 on field_occurrences.id = query_fo_otus1.id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#from_geographic_items(geographic_items_where_sql) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/queries/otu/filter.rb', line 318

def from_geographic_items(geographic_items_where_sql)
  ces = collecting_events_for_geographic_item_condition(
    geographic_items_where_sql
  )

  q1 = ::Otu
    .joins(collection_objects: [:collecting_event])
    .where(collecting_events: ces.all, project_id:)

  ads = ::Queries::AssertedDistribution::Filter
    .from_geographic_items(geographic_items_where_sql)

  q2 = ::Otu
    .joins(:asserted_distributions)
    .where(asserted_distributions: ads.all, project_id:)

  referenced_klass_union([q1,q2])
end

#from_wkt(wkt_shape, wkt_geometry_type = nil) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/queries/otu/filter.rb', line 300

def from_wkt(wkt_shape, wkt_geometry_type = nil)
  c = ::Queries::CollectingEvent::Filter.new(
    wkt: wkt_shape, wkt_geometry_type:, project_id:
  )
  a = ::Queries::AssertedDistribution::Filter.new(
    wkt: wkt_shape, project_id:
  )

  q1 = ::Otu
    .joins(collection_objects: [:collecting_event])
    .where(collecting_events: c.all, project_id:)
  q2 = ::Otu
    .joins(:asserted_distributions)
    .where(asserted_distributions: a.all, project_id:)

  referenced_klass_union([q1, q2]).distinct # Not needed, union should be distinct
end

#geo_json_facet ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/queries/otu/filter.rb', line 337

def geo_json_facet
  return nil if geo_json.blank?
  return ::Otu.none if roll_call

  c = ::Queries::CollectingEvent::Filter.new(geo_json:, project_id:, radius:)
  a = ::Queries::AssertedDistribution::Filter.new(geo_json:, project_id:, radius:)

  q1 = ::Otu.joins(collection_objects: [:collecting_event]).where(collecting_events: c.all, project_id:)
  q2 = ::Otu.joins(:asserted_distributions).where(asserted_distributions: a.all, project_id:)

  referenced_klass_union([q1, q2]).distinct
end

#loan_query_facet ⇒ Object 



661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/queries/otu/filter.rb', line 661

def loan_query_facet
  return nil if loan_query.nil?
  s = 'WITH query_loan_otus AS (' + loan_query.all.to_sql + ') '

  a = ::Otu.joins(:loan_items)
    .joins('JOIN query_loan_otus as query_loan_otus1 on loan_items.loan_id = query_loan_otus1.id')

  b = ::Otu.joins(collection_objects: [:loan_items])
    .joins('JOIN query_loan_otus as query_loan_otus1 on loan_items.loan_id = query_loan_otus1.id')

  s << referenced_klass_union([a, b]).to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#merge_clauses ⇒ Object 



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/queries/otu/filter.rb', line 788

def merge_clauses
  [
    anatomical_part_query_facet,
    asserted_distribution_query_facet,
    asserted_distributions_facet,
    biological_association_query_facet,
    collecting_event_query_facet,
    collection_object_query_facet,
    dwc_occurrences_facet,
    dwc_occurrence_query_facet,
    field_occurrence_query_facet,
    content_query_facet,
    descriptor_query_facet,
    extract_query_facet,
    loan_query_facet,
    observation_query_facet,
    sound_query_facet,
    taxon_name_query_facet,

    biological_association_id_facet,
    biological_associations_facet,
    biological_relationship_id_facet,
    collecting_event_id_facet,
    collection_objects_facet,
    common_names_facet,
    contents_facet,
    descriptor_id_facet,
    geo_json_facet,
    observations_facet,
    otu_geo_facet,
    taxon_name_id_facet,
    with_name_facet,
    wkt_facet,
  ].compact
end

#name_facet ⇒ Object 



273
274
275
276
277
278
279
280
 
# File 'lib/queries/otu/filter.rb', line 273

def name_facet
  return nil if name.empty?
  if name_exact
    table[:name].in(name)
  else
    table[:name].matches_any(name.collect { |n| '%' + n.gsub(/\s+/, '%') + '%' })
  end
end

#observation_query_facet ⇒ Object 



676
677
678
679
680
681
682
683
684
685
 
# File 'lib/queries/otu/filter.rb', line 676

def observation_query_facet
  return nil if observation_query.nil?
  s = 'WITH query_obs_otus AS (' + observation_query.all.to_sql + ') ' +
    ::Otu
    .joins(:observations)
    .joins('JOIN query_obs_otus as query_obs_otus1 on observations.id = query_obs_otus1.id')
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#observations_facet ⇒ Object 



426
427
428
429
430
431
432
433
434
 
# File 'lib/queries/otu/filter.rb', line 426

def observations_facet
  return nil if observations.nil?

  if observations
    ::Otu.joins(:observations).distinct
  else
    ::Otu.where.missing(:observations)
  end
end

#otu_geo_facet ⇒ Object 



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/queries/otu/filter.rb', line 508

def otu_geo_facet
  return nil if geo_shape_id.empty? || geo_shape_type.empty? ||
    # TODO: this should raise an error(?)
    geo_shape_id.length != geo_shape_type.length
    return ::Otu.none if roll_call

  geographic_area_shapes, gazetteer_shapes = shapes_for_geo_mode

  a, b = otu_geo_facet_by_type('GeographicArea', geographic_area_shapes)

  c, _d = otu_geo_facet_by_type('Gazetteer', gazetteer_shapes)

  if geo_mode != true # exact or descendants
    return referenced_klass_union([a,b,c])
  end

  # Spatial.
  i = ::Queries.union(::GeographicItem, [a,c])

  from_geographic_items(
    ::GeographicItem.covered_by_geographic_items_sql(i)
  )
end

#otu_geo_facet_by_type(shape_string, shape_ids) ⇒ Object 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/queries/otu/filter.rb', line 532

def otu_geo_facet_by_type(shape_string, shape_ids)
  b = nil # from AssertedDistributions
  c = nil # from CollectionObjects

  case geo_mode
  when nil, false # exact, descendants
    b = ::Otu.joins(:asserted_distributions)
     .where(asserted_distributions: {
        asserted_distribution_shape: shape_ids
     })
    if shape_string == 'GeographicArea'
      c = ::Otu.joins(collection_objects: [:collecting_event])
        .where(collecting_events: { geographic_area: shape_ids })
    end
  when true # spatial
    m = shape_string.tableize
    b = ::GeographicItem.joins(m.to_sym).where(m => shape_ids)
  end

  [b,c]
end

#sound_query_facet ⇒ Object 



687
688
689
 
# File 'lib/queries/otu/filter.rb', line 687

def sound_query_facet
  otus_from_sound_query
end

#taxon_name_facet ⇒ Object 



416
417
418
419
420
421
422
423
424
 
# File 'lib/queries/otu/filter.rb', line 416

def taxon_name_facet
  return nil if taxon_name.nil?

  if taxon_name
    table[:taxon_name_id].not_eq(nil)
  else
    table[:taxon_name_id].eq(nil)
  end
end

#taxon_name_id_facet ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/queries/otu/filter.rb', line 282

def taxon_name_id_facet
  return nil if taxon_name_id.empty?
  if descendants
    h = Arel::Table.new(:taxon_name_hierarchies)
    j = table.join(h, Arel::Nodes::InnerJoin).on(table[:taxon_name_id].eq(h[:descendant_id]))
    z = h[:ancestor_id].in(taxon_name_id)

    ::Otu.joins(j.join_sources).where(z).distinct # Maybe not needed
  else
    ::Otu.where(taxon_name_id:)
  end
end

#taxon_name_query_facet ⇒ Object 



639
640
641
642
643
644
645
646
647
648
 
# File 'lib/queries/otu/filter.rb', line 639

def taxon_name_query_facet
  return nil if taxon_name_query.nil?
  s = 'WITH query_taxon_names AS (' + taxon_name_query.all.to_sql + ') ' +
    ::Otu
    .joins('JOIN query_taxon_names as query_taxon_names1 on otus.taxon_name_id = query_taxon_names1.id')
    .where.not(taxon_name_id: nil) # .joins(:taxon_name)
    .to_sql

  ::Otu.from('(' + s + ') as otus').distinct
end

#with_name_facet ⇒ Object 



359
360
361
362
363
364
365
366
 
# File 'lib/queries/otu/filter.rb', line 359

def with_name_facet
  return nil if with_name.nil?
  if with_name
    ::Otu.where.not(name: nil)
  else
    ::Otu.where(name: nil)
  end
end

#wkt_facet ⇒ Object 



295
296
297
298
 
# File 'lib/queries/otu/filter.rb', line 295

def wkt_facet
  return nil if wkt.nil?
  from_wkt(wkt)
end