Class: Queries::BiologicalAssociation::Filter

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

Constant Summary collapse

PARAMS =
[
  :biological_association_id,
  :biological_associations_graph_id,
  :biological_relationship_id,
  :collecting_event_id,
  :collection_object_as_subject_or_as_object,
  :collection_object_id,
  :descendants,
  :exclude_taxon_name_relationship,
  :field_occurrence_id,
  :geo_json,
  :geo_mode,
  :geo_shape_id,
  :geo_shape_type,
  :geo_collecting_event_geographic_area,
  :object_biological_property_id,
  :object_object_global_id,
  :object_taxon_name_id,
  :object_type,
  :otu_id,
  :radius,
  :subject_biological_property_id,
  :subject_object_global_id,
  :subject_taxon_name_id,
  :subject_type,
  :taxon_name_id,
  :taxon_name_id_mode,
  :wkt,
  :biological_association_object_id,
  :biological_association_object_type,
  :biological_association_subject_id,
  :biological_association_subject_type,

  any_global_id: [],
  biological_association_id: [],
  biological_associations_graph_id: [],
  biological_relationship_id: [],
  collecting_event_id: [],
  collection_object_id: [],
  field_occurrence_id: [],
  geo_shape_id: [],
  geo_shape_type: [],
  object_biological_property_id: [],
  object_object_global_id: [],
  object_taxon_name_id: [],
  otu_id: [],
  subject_biological_property_id: [],
  subject_object_global_id: [],
  subject_taxon_name_id: [],
  taxon_name_id: [],
  biological_association_object_id: [],
  biological_association_object_type: [],
  biological_association_subject_id: [],
  biological_association_subject_type: []
].freeze
API_PARAM_EXCLUSIONS =
[
  :any_global_id
]

Constants inherited from Query::Filter

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

Instance Attribute Summary collapse

Attributes inherited from Query::Filter

#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 inherited from Query::Filter

#all, #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?, #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.



192
193
194
195
196
197
198
199
200
201
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
# File 'lib/queries/biological_association/filter.rb', line 192

def initialize(query_params)
  super

  @any_global_id = params[:any_global_id]
  @biological_association_id = params[:biological_association_id]
  @biological_associations_graph_id = params[:biological_associations_graph_id]
  @biological_relationship_id = params[:biological_relationship_id]
  @collecting_event_id = params[:collecting_event_id]
  @collection_object_as_subject_or_as_object = params[:collection_object_as_subject_or_as_object]
  @collection_object_id = params[:collection_object_id]
  @field_occurrence_id = params[:field_occurrence_id]
  @descendants = boolean_param(params, :descendants)
  @exclude_taxon_name_relationship = boolean_param(params, :exclude_taxon_name_relationship)
  @geo_shape_type = params[:geo_shape_type]
  @geo_shape_id = integer_param(params, :geo_shape_id)
  @geo_mode = boolean_param(params, :geo_mode)
  @geo_collecting_event_geographic_area = boolean_param(params, :geo_collecting_event_geographic_area)
  @geo_json = params[:geo_json]
  @object_biological_property_id = params[:object_biological_property_id]
  @object_object_global_id = params[:object_object_global_id]
  @object_taxon_name_id = params[:object_taxon_name_id]
  @object_type = params[:object_type]
  @otu_id = params[:otu_id]
  @radius = params[:radius].presence || 100.0
  @subject_biological_property_id = params[:subject_biological_property_id]
  @subject_object_global_id = params[:subject_object_global_id]
  @subject_taxon_name_id = params[:subject_taxon_name_id]
  @subject_type = params[:subject_type]
  @taxon_name_id = params[:taxon_name_id]
  @taxon_name_id_mode = boolean_param(params, :taxon_name_id_mode)
  @wkt = params[:wkt]
  @biological_association_object_id = params[:biological_association_object_id]
  @biological_association_object_type = params[:biological_association_object_type]
  @biological_association_subject_id = params[:biological_association_subject_id]
  @biological_association_subject_type = params[:biological_association_subject_type]

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

Instance Attribute Details

#any_global_idArray

Returns:

  • (Array)


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

def any_global_id
  @any_global_id
end

#biological_association_idArray

Returns one or more BiologicalAssociation#id.

Parameters:

  • biological_association_id (Array, Integer)

Returns:

  • (Array)

    one or more BiologicalAssociation#id



146
147
148
# File 'lib/queries/biological_association/filter.rb', line 146

def biological_association_id
  @biological_association_id
end

#biological_association_object_idObject

Returns the value of attribute biological_association_object_id.



180
181
182
# File 'lib/queries/biological_association/filter.rb', line 180

def biological_association_object_id
  @biological_association_object_id
end

#biological_association_object_typeObject

Returns the value of attribute biological_association_object_type.



182
183
184
# File 'lib/queries/biological_association/filter.rb', line 182

def biological_association_object_type
  @biological_association_object_type
end

#biological_association_subject_idObject

Returns the value of attribute biological_association_subject_id.



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

def biological_association_subject_id
  @biological_association_subject_id
end

#biological_association_subject_typeObject

Returns the value of attribute biological_association_subject_type.



186
187
188
# File 'lib/queries/biological_association/filter.rb', line 186

def biological_association_subject_type
  @biological_association_subject_type
end

#biological_associations_graph_idArray

Returns a biological relationship graph ID.

Parameters:

  • biological_associations_graph_id (Array, Integer)

Returns:

  • (Array)

    a biological relationship graph ID



133
134
135
# File 'lib/queries/biological_association/filter.rb', line 133

def biological_associations_graph_id
  @biological_associations_graph_id
end

#biological_relationship_idArray

See also exclude_taxon_name_relationship

Parameters:

  • biological_relationship_id (Array, Integer)

Returns:

  • (Array)

    one or more biological relationship ID



152
153
154
# File 'lib/queries/biological_association/filter.rb', line 152

def biological_relationship_id
  @biological_relationship_id
end

#collecting_event_idObject

linked to one or more CollectingEvent

Parameters:

  • collecting_event_id

Returns:

  • Integer All BiologicalAssociations with CollectionObjects



82
83
84
# File 'lib/queries/biological_association/filter.rb', line 82

def collecting_event_id
  @collecting_event_id
end

#collection_object_as_subject_or_as_objectObject

object. !! Only used in tandem with collection_object_query!

Parameters:

  • collection_object_as_subject_or_as_object

    Whether collection_object_query should be matched against subject or



106
107
108
# File 'lib/queries/biological_association/filter.rb', line 106

def collection_object_as_subject_or_as_object
  @collection_object_as_subject_or_as_object
end

#collection_object_idArray

matching subject OR object

Parameters:

  • collection_object_id

Returns:

  • (Array)

    All biological relationships with CollectionObject (only)



94
95
96
# File 'lib/queries/biological_association/filter.rb', line 94

def collection_object_id
  @collection_object_id
end

#descendantsObject

Returns the value of attribute descendants.



129
130
131
# File 'lib/queries/biological_association/filter.rb', line 129

def descendants
  @descendants
end

#exclude_taxon_name_relationshipObject

those listed in biological_relationship_id

Returns:

  • Boolean, nil if true then return relationships excluding



76
77
78
# File 'lib/queries/biological_association/filter.rb', line 76

def exclude_taxon_name_relationship
  @exclude_taxon_name_relationship
end

#field_occurrence_idArray

matching subject OR object

Parameters:

  • field_occurrence_id

Returns:

  • (Array)

    All biological relationships with FieldOccurrence (only)



100
101
102
# File 'lib/queries/biological_association/filter.rb', line 100

def field_occurrence_id
  @field_occurrence_id
end

#geo_jsonObject

Returns the value of attribute geo_json.



170
171
172
# File 'lib/queries/biological_association/filter.rb', line 170

def geo_json
  @geo_json
end

#object_biological_property_idArray

Returns All BiologicalAssociations with object having this property.

Returns:

  • (Array)

    All BiologicalAssociations with object having this property



141
142
143
# File 'lib/queries/biological_association/filter.rb', line 141

def object_biological_property_id
  @object_biological_property_id
end

#object_object_global_idArray

Returns:

  • (Array)


163
164
165
# File 'lib/queries/biological_association/filter.rb', line 163

def object_object_global_id
  @object_object_global_id
end

#object_taxon_name_idObject

its children !! TaxonName must be valid!

Parameters:

  • object_taxon_name_id

    All BiologicalAssociations matching this name or



118
119
120
# File 'lib/queries/biological_association/filter.rb', line 118

def object_taxon_name_id
  @object_taxon_name_id
end

#object_typenil, ...

Returns limit object to a type.

Returns:



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

def object_type
  @object_type
end

#otu_idArray

matching subject OR object

Parameters:

  • otu_id

Returns:

  • (Array)

    All BiologicalAssociations with OTU (only)



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

def otu_id
  @otu_id
end

#radiusObject

Integer in Meters

!! defaults to 100m


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

def radius
  @radius
end

#subject_biological_property_idArray

Returns All BiologicalAssociations with subject having this property.

Returns:

  • (Array)

    All BiologicalAssociations with subject having this property



137
138
139
# File 'lib/queries/biological_association/filter.rb', line 137

def subject_biological_property_id
  @subject_biological_property_id
end

#subject_object_global_idArray

Returns:

  • (Array)


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

def subject_object_global_id
  @subject_object_global_id
end

#subject_taxon_name_idObject

its children. !! TaxonName must be valid!

Parameters:

  • subject_taxon_name_id

    All BiologicalAssociations matching this name or



112
113
114
# File 'lib/queries/biological_association/filter.rb', line 112

def subject_taxon_name_id
  @subject_taxon_name_id
end

#subject_typenil, ...

Returns limit subject to a type.

Returns:



174
175
176
# File 'lib/queries/biological_association/filter.rb', line 174

def subject_type
  @subject_type
end

#taxon_name_idArray

their children

Parameters:

  • taxon_name_id

Returns:

  • (Array)

    All BiologicalAssociations matching these names or



124
125
126
# File 'lib/queries/biological_association/filter.rb', line 124

def taxon_name_id
  @taxon_name_id
end

#taxon_name_id_modeBoolean?

Returns:

  • (Boolean, nil)


127
128
129
# File 'lib/queries/biological_association/filter.rb', line 127

def taxon_name_id_mode
  @taxon_name_id_mode
end

#wktObject

See lib/queries/otu/filter.rb



169
170
171
# File 'lib/queries/biological_association/filter.rb', line 169

def wkt
  @wkt
end

Instance Method Details

#and_clausesObject



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
# File 'lib/queries/biological_association/filter.rb', line 882

def and_clauses
  [
    any_global_id_facet,
    biological_association_id_facet,
    biological_relationship_id_facet,
    object_object_global_id_facet,
    object_type_facet,
    subject_object_global_id_facet,
    subject_type_facet,
    biological_association_object_id_facet,
    biological_association_object_type_facet,
    biological_association_subject_id_facet,
    biological_association_subject_id_facet
  ]
end

#any_global_id_facetObject



717
718
719
720
721
722
723
724
725
726
# File 'lib/queries/biological_association/filter.rb', line 717

def any_global_id_facet
  return nil if any_global_id.empty?
  a = matching_global_id(:subject, any_global_id)
  b = matching_global_id(:object, any_global_id)
  if a && b
    return a.or(b)
  else
    return a ? a : b
  end
end

#asserted_distribution_query_facetObject



784
785
786
787
788
789
790
# File 'lib/queries/biological_association/filter.rb', line 784

def asserted_distribution_query_facet
  return nil if asserted_distribution_query.nil?

  ::BiologicalAssociation
    .with(ad: asserted_distribution_query.all)
    .joins("JOIN asserted_distributions ON asserted_distributions.asserted_distribution_object_id = biological_associations.id AND asserted_distributions.asserted_distribution_object_type = 'BiologicalAssociation'").distinct
end

#base_collection_object_query(opts) ⇒ Object



510
511
512
# File 'lib/queries/biological_association/filter.rb', line 510

def base_collection_object_query(opts)
  ::Queries::CollectionObject::Filter.new(opts)
end

#base_field_occurrence_query(opts) ⇒ Object



514
515
516
# File 'lib/queries/biological_association/filter.rb', line 514

def base_field_occurrence_query(opts)
  ::Queries::FieldOccurrence::Filter.new(opts)
end

#base_otu_query(opts) ⇒ Object



506
507
508
# File 'lib/queries/biological_association/filter.rb', line 506

def base_otu_query(opts)
  ::Queries::Otu::Filter.new(opts)
end

#base_queries_to_subject_object(otu_query, collection_object_query, field_occurrence_query, target) ⇒ Object



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'lib/queries/biological_association/filter.rb', line 686

def base_queries_to_subject_object(
  otu_query, collection_object_query, field_occurrence_query, target
)
  o = otu_query.nil? ? ::BiologicalAssociation.none :
    ::BiologicalAssociation
      .with(a: otu_query)
      .joins("JOIN a ON a.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'Otu'")

  co = collection_object_query.nil? ? ::BiologicalAssociation.none :
    ::BiologicalAssociation
      .with(b: collection_object_query)
      .joins("JOIN b ON b.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'CollectionObject'")

  fo = field_occurrence_query.nil? ? ::BiologicalAssociation.none :
    ::BiologicalAssociation
      .with(c: field_occurrence_query)
      .joins("JOIN c ON c.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'FieldOccurrence'")

  referenced_klass_union([o,co,fo])
end

#biological_association_and_subject_object_facetObject

Combines facets that apply to both BA itself and to subject/object.



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
# File 'lib/queries/biological_association/filter.rb', line 861

def biological_association_and_subject_object_facet
  # These are facets that need to be (individually) *unioned* with the
  # subject_object_facet and biological_associations_graph_geo_facet, not
  # intersected.
  # The final result, modulo nils, is just intersection(a) union b.
  a = [wkt_facet, geo_json_facet, biological_association_geo_facet].compact
  b = if biological_associations_graph_geo_facet.nil? &&
         subject_object_facet.nil?
        nil
      else
        referenced_klass_union(
          [biological_associations_graph_geo_facet, subject_object_facet]
        )
      end

  return b if a.empty?

  i = referenced_klass_intersection(a)
  referenced_klass_union([i, b])
end

#biological_association_geo_facetObject

Results are also returned from the otu and CO queries on subject/object.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/queries/biological_association/filter.rb', line 346

def biological_association_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 ::BiologicalAssociation.none if roll_call

  geographic_area_shapes, gazetteer_shapes = shapes_for_geo_mode

  a = biological_association_geo_facet_by_type(
    'GeographicArea', geographic_area_shapes
  )

  b = biological_association_geo_facet_by_type(
    'Gazetteer', gazetteer_shapes
  )

  if geo_mode == true # spatial
    i = ::Queries.union(::GeographicItem, [a,b])
    u = ::Queries::GeographicItem.st_union_text(i).to_a.first

    return from_wkt(u['st_astext'])
  end

  referenced_klass_union([a,b])
end

#biological_association_geo_facet_by_type(shape_string, shape_ids) ⇒ Object



372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/queries/biological_association/filter.rb', line 372

def biological_association_geo_facet_by_type(shape_string, shape_ids)
  case geo_mode
  when nil, false # exact, descendants
    ::BiologicalAssociation
      .joins("JOIN asserted_distributions ON asserted_distributions.asserted_distribution_object_id = biological_associations.id AND asserted_distributions.asserted_distribution_object_type = 'BiologicalAssociation'")
      .where(asserted_distributions: {
        asserted_distribution_shape: shape_ids
     })
  when true # spatial
    m = shape_string.tableize
    b = ::GeographicItem.joins(m.to_sym).where(m => shape_ids)
  end
end

#biological_association_id_facetObject



737
738
739
740
# File 'lib/queries/biological_association/filter.rb', line 737

def biological_association_id_facet
  return nil if biological_association_id.empty?
  table[:id].in(biological_association_id)
end

#biological_association_object_id_facetObject



422
423
424
425
# File 'lib/queries/biological_association/filter.rb', line 422

def biological_association_object_id_facet
  return nil if biological_association_object_id.empty?
  table[:biological_association_object_id].in(biological_association_object_id)
end

#biological_association_object_type_facetObject



417
418
419
420
# File 'lib/queries/biological_association/filter.rb', line 417

def biological_association_object_type_facet
  return nil if biological_association_object_type.empty?
  table[:biological_association_object_type].in(biological_association_object_type)
end

#biological_association_subject_id_facetObject



432
433
434
435
# File 'lib/queries/biological_association/filter.rb', line 432

def biological_association_subject_id_facet
  return nil if biological_association_subject_id.empty?
  table[:biological_association_subject_id].in(biological_association_subject_id)
end

#biological_association_subject_type_facetObject



427
428
429
430
# File 'lib/queries/biological_association/filter.rb', line 427

def biological_association_subject_type_facet
  return nil if biological_association_subject_type.empty?
  table[:biological_association_subject_type].in(biological_association_subject_type)
end

#biological_associations_graph_geo_facetObject

Results are also returned from the otu and CO queries on subject/object.



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

def biological_associations_graph_geo_facet
  bag_query = ::Queries::BiologicalAssociationsGraph::Filter.new({
    geo_json:,
    geo_shape_id:,
    geo_shape_type:,
    geo_mode:,
    radius:,
    wkt:
  })

  bag_scope = bag_query.all
  return nil if bag_query.only_project?() || bag_scope.nil?

  ::BiologicalAssociation
    .joins(:biological_associations_graphs)
    .where(biological_associations_graphs: {id: bag_scope.select(:id)})
end

#biological_associations_graph_id_facetObject



449
450
451
452
# File 'lib/queries/biological_association/filter.rb', line 449

def biological_associations_graph_id_facet
  return nil if biological_associations_graph_id.empty?
  ::BiologicalAssociation.joins(:biological_associations_graphs).where(biological_associations_graphs: {id: biological_associations_graph_id})
end

#biological_relationship_id_facetObject



728
729
730
731
732
733
734
735
# File 'lib/queries/biological_association/filter.rb', line 728

def biological_relationship_id_facet
  return nil if biological_relationship_id.empty?
  if exclude_taxon_name_relationship
    table[:biological_relationship_id].not_in(biological_relationship_id)
  else
    table[:biological_relationship_id].in(biological_relationship_id)
  end
end

#collecting_event_query_facetObject



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
# File 'lib/queries/biological_association/filter.rb', line 752

def collecting_event_query_facet
  return nil if collecting_event_query.nil?

  s = 'WITH query_ce_ba AS (' + collecting_event_query.all.to_sql + ') '

  a = ::BiologicalAssociation
    .joins("JOIN collection_objects co1 on co1.id = biological_associations.biological_association_subject_id AND biological_associations.biological_association_subject_type = 'CollectionObject'")
    .joins('JOIN query_ce_ba as query_ce_ba1 on co1.collecting_event_id = query_ce_ba1.id')

  b = ::BiologicalAssociation
    .joins("JOIN collection_objects co2 on co2.id = biological_associations.biological_association_object_id AND biological_associations.biological_association_object_type = 'CollectionObject'")
    .joins('JOIN query_ce_ba as query_ce_ba2 on co2.collecting_event_id = query_ce_ba2.id')

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

  ::BiologicalAssociation.from('(' + s + ') as biological_associations')
end

#collection_object_paramsObject



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'lib/queries/biological_association/filter.rb', line 454

def collection_object_params
  h = {}
  [
    :collecting_event_id,
    :collection_object_id,
    :geo_json,
    :geo_mode,
    :geo_shape_id,
    :geo_shape_type,
    :geo_collecting_event_geographic_area,
    :wkt,
  ].each do |p|
    v = send(p)
    h[p] = v if v.present?
  end
  h
end

#collection_object_query_facetObject



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
# File 'lib/queries/biological_association/filter.rb', line 792

def collection_object_query_facet
  return nil if collection_object_query.nil?

  a = ::BiologicalAssociation
    .with(query_co_ba1: collection_object_query.all)
    .joins("JOIN query_co_ba1 ON biological_associations.biological_association_subject_id = query_co_ba1.id AND biological_associations.biological_association_subject_type = 'CollectionObject'")

  b = ::BiologicalAssociation
    .with(query_co_ba2: collection_object_query.all)
    .joins("JOIN query_co_ba2 ON biological_associations.biological_association_object_id = query_co_ba2.id AND biological_associations.biological_association_object_type = 'CollectionObject'")

  if collection_object_as_subject_or_as_object&.to_sym == :subject
    return a
  elsif collection_object_as_subject_or_as_object&.to_sym == :object
    return b
  else
    return referenced_klass_union([a,b])
  end
end

#field_occurrence_paramsObject



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# File 'lib/queries/biological_association/filter.rb', line 472

def field_occurrence_params
  h = {}
  [
    :collecting_event_id,
    :field_occurrence_id,
    :geo_json,
    :geo_mode,
    :geo_shape_id,
    :geo_shape_type,
    :wkt,
  ].each do |p|
    v = send(p)
    h[p] = v if v.present?
  end
  h
end

#field_occurrence_query_facetObject



812
813
814
815
816
817
818
819
820
821
822
823
824
825
# File 'lib/queries/biological_association/filter.rb', line 812

def field_occurrence_query_facet
  return nil if field_occurrence_query.nil?
  s = 'WITH query_fo_ba AS (' + field_occurrence_query.all.to_sql + ') '

  a = ::BiologicalAssociation
    .joins("JOIN query_fo_ba as query_fo_ba1 on biological_associations.biological_association_subject_id = query_fo_ba1.id AND biological_associations.biological_association_subject_type = 'FieldOccurrence'")

  b = ::BiologicalAssociation
    .joins("JOIN query_fo_ba as query_fo_ba2 on biological_associations.biological_association_object_id = query_fo_ba2.id AND biological_associations.biological_association_object_type = 'FieldOccurrence'")

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

  ::BiologicalAssociation.from('(' + s + ') as biological_associations')
end

#from_wkt(wkt_shape) ⇒ Object

Results are also returned from the otu and CO queries on subject/object.



319
320
321
322
323
324
325
326
327
328
# File 'lib/queries/biological_association/filter.rb', line 319

def from_wkt(wkt_shape)
  a = ::Queries::AssertedDistribution::Filter.new(
    wkt: wkt_shape, project_id:,
    asserted_distribution_object_type: 'BiologicalAssociation'
  )

  ::BiologicalAssociation
    .with(ad: a.all)
    .joins('JOIN ad ON ad.asserted_distribution_object_id = biological_associations.id')
end

#geo_json_facetObject

Results are also returned from the otu and CO queries on subject/object.



331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/queries/biological_association/filter.rb', line 331

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

  a = ::Queries::AssertedDistribution::Filter.new(
    geo_json:, project_id:, radius:,
    asserted_distribution_object_type: 'BiologicalAssociation'
  )

  ::BiologicalAssociation
    .with(ad: a.all)
    .joins('JOIN ad ON ad.asserted_distribution_object_id = biological_associations.id')
end

#matching_global_id(target = :subject, global_id = []) ⇒ Object (private)



926
927
928
929
930
931
932
933
934
935
# File 'lib/queries/biological_association/filter.rb', line 926

def matching_global_id(target = :subject, global_id = [])
  a = global_id
  b = "#{target}_matches".to_sym

  q = send(b, object_for(a[0]))
  a[1..a.length].each do |i|
    q = q.or( send(b, object_for(i) ))
  end
  q
end

#merge_clausesObject



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
# File 'lib/queries/biological_association/filter.rb', line 898

def merge_clauses
  [
    asserted_distribution_query_facet,
    collecting_event_query_facet,
    collection_object_query_facet,
    field_occurrence_query_facet,
    otu_query_facet,
    taxon_name_query_facet,

    taxon_name_id_facet,
    biological_associations_graph_id_facet,
    object_biological_property_id_facet,
    subject_biological_property_id_facet,
    # This handles all Otu/CollectionObject attributes
    biological_association_and_subject_object_facet,
  ]
end

#object_biological_property_id_facetObject



437
438
439
440
441
# File 'lib/queries/biological_association/filter.rb', line 437

def object_biological_property_id_facet
  return nil if object_biological_property_id.empty?
  ::BiologicalAssociation.joins(:object_biological_relationship_types)
    .where(biological_relationship_types: {biological_property_id: object_biological_property_id })
end

#object_collection_object_queryObject



532
533
534
535
536
537
538
539
540
541
542
543
544
# File 'lib/queries/biological_association/filter.rb', line 532

def object_collection_object_query
  p = {}
  s = object_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  q = base_collection_object_query(p)
end

#object_field_occurrence_queryObject



560
561
562
563
564
565
566
567
568
569
570
571
572
# File 'lib/queries/biological_association/filter.rb', line 560

def object_field_occurrence_query
  p = {}
  s = object_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  q = base_field_occurrence_query(p)
end

#object_for(global_id) ⇒ Object (private)



918
919
920
921
922
923
924
# File 'lib/queries/biological_association/filter.rb', line 918

def object_for(global_id)
  if o = GlobalID::Locator.locate(global_id)
    o
  else
    nil
  end
end

#object_matches(object) ⇒ Object



411
412
413
414
415
# File 'lib/queries/biological_association/filter.rb', line 411

def object_matches(object)
  table['biological_association_object_id'].eq(object.id).and(
    table['biological_association_object_type'].eq(object.class.base_class.name)
  )
end

#object_object_global_id_facetObject



712
713
714
715
# File 'lib/queries/biological_association/filter.rb', line 712

def object_object_global_id_facet
  return nil if object_object_global_id.empty?
  matching_global_id(:object, object_object_global_id)
end

#object_otu_queryObject



588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'lib/queries/biological_association/filter.rb', line 588

def object_otu_query
  p = {}
  s = object_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  base_otu_query(p)
end

#object_scopeObject



606
607
608
# File 'lib/queries/biological_association/filter.rb', line 606

def object_scope
  target_scope('object')
end

#object_taxon_name_idsObject (private)

!! Plural is correct



938
939
940
941
942
# File 'lib/queries/biological_association/filter.rb', line 938

def object_taxon_name_ids
  return taxon_name_id if !taxon_name_id.empty?
  return object_taxon_name_id if !object_taxon_name_id.empty?
  return []
end

#object_type_facetObject



742
743
744
745
# File 'lib/queries/biological_association/filter.rb', line 742

def object_type_facet
  return nil if object_type.nil?
  table[:biological_association_object_type].eq(object_type)
end

#otu_paramsObject



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/queries/biological_association/filter.rb', line 489

def otu_params
  h = {}
  [
    :geo_json,
    :geo_mode,
    :geo_shape_id,
    :geo_shape_type,
    :geo_collecting_event_geographic_area,
    :otu_id,
    :wkt,
  ].each do |p|
    v = send(p)
    h[p] = v if v.present?
  end
  h
end

#otu_query_facetObject



770
771
772
773
774
775
776
777
778
779
780
781
782
# File 'lib/queries/biological_association/filter.rb', line 770

def otu_query_facet
  return nil if otu_query.nil?
  s = 'WITH query_otu_ba AS (' + otu_query.all.to_sql + ') '

  a = ::BiologicalAssociation
    .joins("JOIN query_otu_ba as query_otu_ba1 on biological_associations.biological_association_subject_id = query_otu_ba1.id AND biological_associations.biological_association_subject_type = 'Otu'")

  b = ::BiologicalAssociation
    .joins("JOIN query_otu_ba as query_otu_ba2 on biological_associations.biological_association_object_id = query_otu_ba2.id AND biological_associations.biological_association_object_type = 'Otu'")

  s << referenced_klass_union([a,b]).to_sql
  ::BiologicalAssociation.from('(' + s + ') as biological_associations')
end

#subject_biological_property_id_facetObject



443
444
445
446
447
# File 'lib/queries/biological_association/filter.rb', line 443

def subject_biological_property_id_facet
  return nil if subject_biological_property_id.empty?
  ::BiologicalAssociation.joins(:subject_biological_relationship_types)
    .where(biological_relationship_types: {biological_property_id: subject_biological_property_id })
end

#subject_collection_object_queryObject



518
519
520
521
522
523
524
525
526
527
528
529
530
# File 'lib/queries/biological_association/filter.rb', line 518

def subject_collection_object_query
  p = {}
  s = subject_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  q = base_collection_object_query(p)
end

#subject_field_occurrence_queryObject



546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'lib/queries/biological_association/filter.rb', line 546

def subject_field_occurrence_query
  p = {}
  s = subject_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  q = base_field_occurrence_query(p)
end

#subject_matches(object) ⇒ Object



405
406
407
408
409
# File 'lib/queries/biological_association/filter.rb', line 405

def subject_matches(object)
  table['biological_association_subject_id'].eq(object.id).and(
    table['biological_association_subject_type'].eq(object.class.base_class.name)
  )
end

#subject_object_facetObject

Merges results from Otu and CollectionObject filters as the basis for the query



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
# File 'lib/queries/biological_association/filter.rb', line 656

def subject_object_facet
  o_params = otu_params
  co_params = collection_object_params
  fo_params = field_occurrence_params
  return nil if o_params.empty? && co_params.empty? && fo_params.empty?

  a = o_params.empty? ? nil : base_otu_query(o_params).all
  b = co_params.empty? ? nil : base_collection_object_query(co_params).all
  c = fo_params.empty? ? nil : base_field_occurrence_query(fo_params).all

  subjects = base_queries_to_subject_object(a, b, c, 'subject')
  objects = base_queries_to_subject_object(a, b, c, 'object')

  referenced_klass_union([subjects,objects])
end

#subject_object_global_id_facetObject



707
708
709
710
# File 'lib/queries/biological_association/filter.rb', line 707

def subject_object_global_id_facet
  return nil if subject_object_global_id.empty?
  matching_global_id(:subject, subject_object_global_id)
end

#subject_otu_queryObject



574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/queries/biological_association/filter.rb', line 574

def subject_otu_query
  p = {}
  s = subject_taxon_name_ids

  if s.empty?
    return nil
  elsif s.present?
    p[:taxon_name_id] = s
    p[:descendants] = descendants
  end

  base_otu_query(p)
end

#subject_scopeObject



602
603
604
# File 'lib/queries/biological_association/filter.rb', line 602

def subject_scope
  target_scope('subject')
end

#subject_taxon_name_idsObject (private)

!! Plural is correct



945
946
947
948
949
# File 'lib/queries/biological_association/filter.rb', line 945

def subject_taxon_name_ids
  return taxon_name_id if !taxon_name_id.empty? # only one or the other supposed to be sent
  return subject_taxon_name_id if !subject_taxon_name_id.empty?
  return []
end

#subject_type_facetObject



747
748
749
750
# File 'lib/queries/biological_association/filter.rb', line 747

def subject_type_facet
  return nil if subject_type.nil?
  table[:biological_association_subject_type].eq(subject_type)
end

#target_scope(target = 'subject') ⇒ Object



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'lib/queries/biological_association/filter.rb', line 610

def target_scope(target = 'subject')
  a = send((target + '_otu_query').to_sym)
  b = send((target + '_collection_object_query').to_sym)
  c = send((target + '_field_occurrence_query').to_sym)

  a_query, b_query, c_query = nil, nil, nil

  if !a.nil? && !a.only_project?
    a_query = a.all
  end

  if !b.nil? && !b.only_project?
    b_query = b.all
  end

  if !c.nil? && !c.only_project?
    c_query = c.all
  end

  return nil if a_query.nil? && b_query.nil? && c_query.nil?

  d, e, f = nil, nil, nil

  if a_query
    d = ::BiologicalAssociation
      .with(a: a_query)
      .joins("JOIN a ON a.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'Otu'")
  end

  if b_query
    e = ::BiologicalAssociation
      .with(b: b_query)
      .joins("JOIN b ON b.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'CollectionObject'")
  end

  if c_query
    f = ::BiologicalAssociation
      .with(c: c_query)
      .joins("JOIN c ON c.id = biological_associations.biological_association_#{target}_id AND biological_associations.biological_association_#{target}_type = 'FieldOccurrence'")
  end

  referenced_klass_union([d,e,f])
end

#taxon_name_id_facetObject



672
673
674
675
676
677
678
679
680
681
682
683
684
# File 'lib/queries/biological_association/filter.rb', line 672

def taxon_name_id_facet
  return nil if subject_taxon_name_ids.empty? && object_taxon_name_ids.empty?

  a = subject_scope
  b = object_scope

  case taxon_name_id_mode
  when true # and
    referenced_klass_intersection([a,b])
  when false, nil # or
    referenced_klass_union([a,b])
  end
end

#taxon_name_query_facetObject

Brute-force style



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
# File 'lib/queries/biological_association/filter.rb', line 828

def taxon_name_query_facet
  return nil if taxon_name_query.nil?

  s = 'WITH query_tn_ba AS (' + taxon_name_query.all.to_sql + ') '

  a = ::BiologicalAssociation
    .joins("JOIN otus on otus.id = biological_associations.biological_association_subject_id AND biological_associations.biological_association_subject_type = 'Otu'")
    .joins('JOIN query_tn_ba as query_tn_ba1 on otus.taxon_name_id = query_tn_ba1.id')

  b = ::BiologicalAssociation
    .joins("JOIN otus on otus.id = biological_associations.biological_association_object_id AND biological_associations.biological_association_object_type = 'Otu'")
    .joins('JOIN query_tn_ba as query_tn_ba2 on otus.taxon_name_id = query_tn_ba2.id')

  c = ::BiologicalAssociation
    .joins("JOIN collection_objects on collection_objects.id = biological_associations.biological_association_subject_id AND biological_associations.biological_association_subject_type = 'CollectionObject'")
    .joins("JOIN taxon_determinations on taxon_determinations.taxon_determination_object_id = collection_objects.id AND taxon_determinations.taxon_determination_object_type = 'CollectionObject'")
    .joins('JOIN otus on otus.id = taxon_determinations.otu_id')
    .joins('JOIN query_tn_ba as query_tn_ba3 on otus.taxon_name_id = query_tn_ba3.id')
    .where('taxon_determinations.position = 1')

  d = ::BiologicalAssociation
    .joins("JOIN collection_objects on collection_objects.id = biological_associations.biological_association_object_id AND biological_associations.biological_association_object_type = 'CollectionObject'")
    .joins("JOIN taxon_determinations on taxon_determinations.taxon_determination_object_id = collection_objects.id AND taxon_determinations.taxon_determination_object_type = 'CollectionObject'")
    .joins('JOIN otus on otus.id = taxon_determinations.otu_id')
    .joins('JOIN query_tn_ba as query_tn_ba4 on otus.taxon_name_id = query_tn_ba4.id')
    .where('taxon_determinations.position = 1')

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

  ::BiologicalAssociation.from('(' + s + ') as biological_associations')
end

#wkt_facetObject



313
314
315
316
# File 'lib/queries/biological_association/filter.rb', line 313

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