module ActiveFedora::SolrQueryBuilder
Public Class Methods
Construct a solr query from a list of pairs (e.g. [field name, values]) @param [Array<Array>] field_pairs a list of pairs of property name and values @param [String] join_with (‘AND’) the value we’re joining the clauses with @param [String] type (‘field’) The type of query to run. Either ‘raw’ or ‘field’ @return [String] a solr query @example
construct_query([['library_id_ssim', '123'], ['owner_ssim', 'Fred']]) # => "_query_:\"{!field f=library_id_ssim}123\" AND _query_:\"{!field f=owner_ssim}Fred\""
# File lib/active_fedora/solr_query_builder.rb, line 35 def construct_query(field_pairs, join_with = default_join_with, type = 'field'.freeze) clauses = pairs_to_clauses(field_pairs, type) return "" if clauses.count.zero? return clauses.first if clauses.count == 1 "(#{clauses.join(join_with)})" end
Construct a solr query for a list of ids This is used to get a solr response based on the list of ids in an object’s RELS-EXT relationhsips If the id_array is empty, defaults to a query of “id:NEVER_USE_THIS_ID”, which will return an empty solr response @param [Array] id_array the ids that you want included in the query
# File lib/active_fedora/solr_query_builder.rb, line 8 def construct_query_for_ids(id_array) ids = id_array.reject(&:blank?) return "id:NEVER_USE_THIS_ID" if ids.empty? "{!terms f=#{ActiveFedora.id_field}}#{ids.join(',')}" end
Create a raw query with a clause for each key, value @param [Hash, Array<Array<String>>] field_pairs key is the predicate, value is the target_uri @param [String] join_with (‘AND’) the value we’re joining the clauses with @example
construct_query_for_rel [[:has_model, "ComplexCollection"], [:has_model, "ActiveFedora_Base"]], 'OR' # => _query_:"{!raw f=has_model_ssim}ComplexCollection" OR _query_:"{!raw f=has_model_ssim}ActiveFedora_Base" construct_query_for_rel [[Book._reflect_on_association(:library), "foo/bar/baz"]]
# File lib/active_fedora/solr_query_builder.rb, line 22 def construct_query_for_rel(field_pairs, join_with = default_join_with) field_pairs = field_pairs.to_a if field_pairs.is_a? Hash construct_query(property_values_to_solr(field_pairs), join_with, 'raw'.freeze) end
# File lib/active_fedora/solr_query_builder.rb, line 42 def default_join_with ' AND ' end
Private Class Methods
@param [String] field @param [String, Array<String>] values @param [String] type The type of query to run. Either ‘raw’ or ‘field’ @return [Array<String>]
# File lib/active_fedora/solr_query_builder.rb, line 61 def condition_to_clauses(field, values, type) values = Array(values) values << nil if values.empty? values.map do |value| if value.present? query_clause(type, field, value) else # Check that the field is not present. In SQL: "WHERE field IS NULL" "-#{field}:[* TO *]" end end end
@param [Array<Array>] pairs a list of (key, value) pairs. The value itself may @param [String] type The type of query to run. Either ‘raw’ or ‘field’ @return [Array] a list of solr clauses
# File lib/active_fedora/solr_query_builder.rb, line 51 def pairs_to_clauses(pairs, type) pairs.flat_map do |field, value| condition_to_clauses(field, value, type) end end
Given a list of pairs (e.g. [field name, values]), convert the field names to solr names @param [Array<Array>] pairs a list of pairs of property name and values @return [Hash] map of solr fields to values @example
property_values_to_solr([['library_id', '123'], ['owner', 'Fred']]) # => [['library_id_ssim', '123'], ['owner_ssim', 'Fred']]
# File lib/active_fedora/solr_query_builder.rb, line 81 def property_values_to_solr(pairs) pairs.map do |(property, value)| [solr_field(property), value] end end
Create a raw query clause suitable for sending to solr as an fq element @param [String] type The type of query to run. Either ‘raw’ or ‘field’ @param [String] key @param [String] value
# File lib/active_fedora/solr_query_builder.rb, line 102 def query_clause(type, key, value) "_query_:\"{!#{type} f=#{key}}#{value.gsub('"', '\"')}\"" end
@param [String, ActiveFedora::Relation
] field @return [String] the corresponding solr field for the string
# File lib/active_fedora/solr_query_builder.rb, line 89 def solr_field(field) case field when ActiveFedora::Reflection::AssociationReflection field.solr_key else ActiveFedora.index_field_mapper.solr_name(field, :symbol) end end