Class: ActiveFedora::SolrService

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/active_fedora/solr_service.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, args) ⇒ SolrService

Returns a new instance of SolrService.



18
19
20
21
22
23
 
# File 'lib/active_fedora/solr_service.rb', line 18

def initialize(host, args)
  host = 'http://localhost:8080/solr' unless host
  args = {:read_timeout => 120, :open_timeout => 120}.merge(args.dup)
  args.merge!(:url=>host)
  @conn = RSolr.connect args
end

Instance Attribute Details

#conn ⇒ Object (readonly)

Returns the value of attribute conn.



8
9
10
 
# File 'lib/active_fedora/solr_service.rb', line 8

def conn
  @conn
end

Class Method Details

.add(doc) ⇒ Object 



130
131
132
 
# File 'lib/active_fedora/solr_service.rb', line 130

def self.add(doc)
  SolrService.instance.conn.add(doc)
end

.class_from_solr_document(hit, opts = {}) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/active_fedora/solr_service.rb', line 57

def self.class_from_solr_document(hit, opts = {})
  #Set the default starting point to the class specified, if available.
  best_model_match = Model.from_class_uri(opts[:class]) unless opts[:class].nil?

  hit[solr_name("has_model", :symbol)].each do |value|

    model_value = Model.from_class_uri(value)

    if model_value

      # Set as the first model in case opts[:class] was nil
      best_model_match ||= model_value

      # If there is an inheritance structure, use the most specific case.
      if best_model_match > model_value
        best_model_match = model_value
      end
    end
  end

  logger.warn "Could not find a model for #{hit["id"]}, defaulting to ActiveFedora::Base" unless best_model_match
  best_model_match || ActiveFedora::Base
end

.commit ⇒ Object 



134
135
136
 
# File 'lib/active_fedora/solr_service.rb', line 134

def self.commit
  SolrService.instance.conn.commit
end

.construct_query_for_pids(pid_array) ⇒ Object

Construct a solr query for a list of pids This is used to get a solr response based on the list of pids in an object’s RELS-EXT relationhsips If the pid_array is empty, defaults to a query of “id:NEVER_USE_THIS_ID”, which will return an empty solr response

Parameters:

  • pid_array (Array) —

    the pids that you want included in the query



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/active_fedora/solr_service.rb', line 85

def self.construct_query_for_pids(pid_array)

  q = pid_array.reject { |x| x.empty? }.map do |pid|
    "_query_:\"{!raw f=#{SOLR_DOCUMENT_ID}}#{pid.gsub('"', '\"')}\""
  end

  return "id:NEVER_USE_THIS_ID" if q.empty?

  return q.join(" OR ")
end

.construct_query_for_rel(args) ⇒ Object

Create a query with a clause for each key, value

Parameters:

  • args (Hash) —

    key is the predicate, value is the target_uri



106
107
108
109
110
111
 
# File 'lib/active_fedora/solr_service.rb', line 106

def self.construct_query_for_rel(args)
  clauses = args.map do |predicate, target_uri|
    "_query_:\"{!raw f=#{solr_name(predicate, :symbol)}}#{target_uri.gsub('"', '\"')}\""
  end
  clauses.join(" AND ")
end

.count(query, args = {}) ⇒ Integer

Get the count of records that match the query

Parameters:

  • query (String) —

    a solr query

  • args (Hash) (defaults to: {}) —

    arguments to pass through to ‘args’ param of SolrService.query (note that :rows will be overwritten to 0)

Returns:

  • (Integer) —

    number of records matching



125
126
127
128
 
# File 'lib/active_fedora/solr_service.rb', line 125

def self.count(query, args={})
  args = args.merge(:raw=>true, :rows=>0)
  SolrService.query(query, args)['response']['numFound'].to_i
end

.escape_uri_for_query(uri) ⇒ Object 



100
101
102
 
# File 'lib/active_fedora/solr_service.rb', line 100

def self.escape_uri_for_query(uri)
  return uri.gsub(/(:)/, '\\:').gsub(/(\/)/, '\\/')
end

.instance ⇒ Object

Raises:



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/active_fedora/solr_service.rb', line 25

def self.instance
# Register Solr
    
  unless Thread.current[:solr_service]
    register(ActiveFedora.solr_config[:url])
  end

  raise SolrNotInitialized unless Thread.current[:solr_service]
  Thread.current[:solr_service]
end

.lazy_reify_solr_results(solr_results, opts = {}) ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/active_fedora/solr_service.rb', line 36

def self.lazy_reify_solr_results(solr_results, opts = {})
  Enumerator.new do |yielder|
    solr_results.each do |hit|
      yielder.yield(reify_solr_result(hit, opts))
    end
  end
end

.query(query, args = {}) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/active_fedora/solr_service.rb', line 113

def self.query(query, args={})
  raw = args.delete(:raw)
  args = args.merge(:q=>query, :qt=>'standard')
  result = SolrService.instance.conn.get('select', :params=>args)
  return result if raw
  result['response']['docs']
end

.register(host = nil, args = {}) ⇒ Object 



10
11
12
 
# File 'lib/active_fedora/solr_service.rb', line 10

def self.register(host=nil, args={})
  Thread.current[:solr_service]=self.new(host, args)
end

.reify_solr_result(hit, opts = {}) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/active_fedora/solr_service.rb', line 48

def self.reify_solr_result(hit, opts = {})
  klass = class_from_solr_document(hit)
  if opts[:load_from_solr]
    klass.load_instance_from_solr(hit[SOLR_DOCUMENT_ID])
  else
    klass.find(hit[SOLR_DOCUMENT_ID], cast: true)
  end
end

.reify_solr_results(solr_results, opts = {}) ⇒ Object 



44
45
46
 
# File 'lib/active_fedora/solr_service.rb', line 44

def self.reify_solr_results(solr_results, opts = {})
  solr_results.collect {|hit| reify_solr_result(hit, opts)}
end

.reset! ⇒ Object 



14
15
16
 
# File 'lib/active_fedora/solr_service.rb', line 14

def self.reset!
  Thread.current[:solr_service] = nil
end

.solr_name(*args) ⇒ Object 



96
97
98
 
# File 'lib/active_fedora/solr_service.rb', line 96

def self.solr_name(*args)
  Solrizer.default_field_mapper.solr_name(*args)
end