Class: Queries::GeographicArea::Filter

Inherits:
Query::Filter show all
Defined in:
lib/queries/geographic_area/filter.rb

Constant Summary collapse

PARAMS = 
[
  :containing_point,
  :geographic_area_id,
  :geographic_items,
  :name,
  geographic_area_id: [],
  name: []
].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, #asserted_environment_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?, #only_project_or_less?, #paging_state, params, #permitted_params, #process_url_into_params, query_name, #raise_multiple_nested_queries, #raise_unregistered_nested_query, #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.



36
37
38
39
40
41
42
 
# File 'lib/queries/geographic_area/filter.rb', line 36

def initialize(query_params)
  super
  @geographic_area_id = params[:geographic_area_id]
  @name = params[:name]
  @containing_point = params[:containing_point]
  @geographic_items = boolean_param(params, :geographic_items)
end

Instance Attribute Details

#containing_point ⇒ Object

Parameters:

  • WKT (String) —

    representation of a point. All areas containing that point are returned e.g. POINT(44 22)



28
29
30
 
# File 'lib/queries/geographic_area/filter.rb', line 28

def containing_point
  @containing_point
end

#geographic_area_id ⇒ Array

Parameters:

  • geographic_area_id (Integer, Array)

Returns:

  • (Array) 


22
23
24
 
# File 'lib/queries/geographic_area/filter.rb', line 22

def geographic_area_id
  @geographic_area_id
end

#geographic_items ⇒ Object

Parameters:

  • geographic_items (Boolean) —

    true - has shape false - has no shape nil - ignored



34
35
36
 
# File 'lib/queries/geographic_area/filter.rb', line 34

def geographic_items
  @geographic_items
end

#name ⇒ Array

Parameters:

  • name (String, Array) —

    matches one or more named entities

Returns:

  • (Array) 


18
19
20
 
# File 'lib/queries/geographic_area/filter.rb', line 18

def name
  @name
end

Instance Method Details

#and_clauses ⇒ Object 



84
85
86
 
# File 'lib/queries/geographic_area/filter.rb', line 84

def and_clauses
  [ name_facet ]
end

#containing_point_facet ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/queries/geographic_area/filter.rb', line 62

def containing_point_facet
  return nil if containing_point.nil?

  ::GeographicArea
    .joins(:geographic_items)
    .where(
      ::GeographicItem.st_covers_sql(
        ::GeographicItem.geography_as_geometry,
        ::GeographicItem.st_geom_from_text_sql(containing_point)
      )
    )
end

#geographic_items_facet ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/queries/geographic_area/filter.rb', line 75

def geographic_items_facet
  return nil if geographic_items.nil?
  if geographic_items
    ::GeographicArea.joins(:geographic_items)
  else
    ::GeographicArea.where.missing(:geographic_items)
  end
end

#merge_clauses ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/queries/geographic_area/filter.rb', line 88

def merge_clauses
  [
    containing_point_facet,
    geographic_items_facet,
 ]
end

#name_facet ⇒ Object 



57
58
59
60
 
# File 'lib/queries/geographic_area/filter.rb', line 57

def name_facet
  return nil if name.blank?
  table[:name].in(name)
end

#project_id_facet ⇒ Object

Required, disable default facet



53
54
55
 
# File 'lib/queries/geographic_area/filter.rb', line 53

def project_id_facet
  nil
end