Module: Solrizer::XML::TerminologyBasedSolrizer

Defined in:
lib/solrizer/xml/terminology_based_solrizer.rb

Overview

This module is only suitable to mix into Classes that use the OM::XML::Document Module

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.generate_solr_symbol(field_name, field_type) ⇒ Object

Use Solrizer::FieldNameMapper to generate an appropriate solr field name field_name and field_type



78
79
80
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 78

def self.generate_solr_symbol(field_name, field_type) # :nodoc:
  Solrizer::FieldNameMapper.solr_name(field_name, field_type)
end

.solrize(doc, solr_doc = Solr::Document.new) ⇒ Object

Build a solr document from doc based on its terminology



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 9

def self.solrize(doc, solr_doc=Solr::Document.new)
  unless doc.class.terminology.nil?
    doc.class.terminology.terms.each_pair do |term_name,term|
      doc.solrize_term(term, solr_doc)     
      # self.solrize_by_term(accessor_name, accessor_info, :solr_doc=>solr_doc)
    end
  end

  return solr_doc
end

.solrize_node(node, doc, term_pointer, term, solr_doc = Solr::Document.new) ⇒ Object

Populate a solr document with solr fields corresponding to the given xml node Field names are generated using settings from the term in the doc‘s terminology corresponding to term_pointer



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 54

def self.solrize_node(node, doc, term_pointer, term, solr_doc = Solr::Document.new)
  terminology = doc.class.terminology
  # term = terminology.retrieve_term(*term_pointer)
  
  if term.path.kind_of?(Hash) && term.path.has_key?(:attribute)
    node_value = node.value
  else
    node_value = node.text
  end
  
  generic_field_name_base = OM::XML::Terminology.term_generic_name(*term_pointer)
  generic_field_name = generate_solr_symbol(generic_field_name_base, term.data_type)
  
  solr_doc << Solr::Field.new(generic_field_name => node_value)
  
  if term_pointer.length > 1
    hierarchical_field_name_base = OM::XML::Terminology.term_hierarchical_name(*term_pointer)
    hierarchical_field_name = self.generate_solr_symbol(hierarchical_field_name_base, term.data_type)
    solr_doc << Solr::Field.new(hierarchical_field_name => node_value)
  end
  solr_doc
end

.solrize_term(doc, term, solr_doc = Solr::Document.new, opts = {}) ⇒ Object

Populate a solr document with fields based on nodes in xml corresponding to the term identified by term_pointer within terminology



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 24

def self.solrize_term(doc, term, solr_doc = Solr::Document.new, opts={})
  terminology = doc.class.terminology
  parents = opts.fetch(:parents, [])

  term_pointer = parents+[term.name]

  # term = terminology.retrieve_term(term_pointer)

  # prep children hash
  # child_accessors = accessor_info.fetch(:children, {})
  # xpath = term.xpath_for(*term_pointer)
  nodeset = doc.find_by_terms(*term_pointer)
  
  nodeset.each do |node|
    # create solr fields
    
    self.solrize_node(node, doc, term_pointer, term, solr_doc)
    term.children.each_pair do |child_term_name, child_term|
      doc.solrize_term(child_term, solr_doc, opts={:parents=>parents+[{term.name=>nodeset.index(node)}]})
      # self.solrize_term(doc, child_term_name, child_term, opts={:solr_doc=>solr_doc, :parents=>parents+[{accessor_name=>nodeset.index(node)}] })
    end
  end
  solr_doc
end

Instance Method Details

#solrize_node(node, term_pointer, term, solr_doc = Solr::Document.new) ⇒ Object 



94
95
96
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 94

def solrize_node(node, term_pointer, term, solr_doc = Solr::Document.new)
  Solrizer::XML::TerminologyBasedSolrizer.solrize_node(node, self, term_pointer, solr_doc)
end

#solrize_term(term, solr_doc = Solr::Document.new, opts = {}) ⇒ Object 



90
91
92
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 90

def solrize_term(term, solr_doc = Solr::Document.new, opts={})
  Solrizer::XML::TerminologyBasedSolrizer.solrize_term(self, term, solr_doc, opts)    
end

#to_solr(solr_doc = Solr::Document.new) ⇒ Object

:nodoc:



85
86
87
 
# File 'lib/solrizer/xml/terminology_based_solrizer.rb', line 85

def to_solr(solr_doc = Solr::Document.new) # :nodoc:
  Solrizer::XML::TerminologyBasedSolrizer.solrize(self, solr_doc)
end