Module: MartSearch::IndexBuilderUtils
- Included in:
- IndexBuilder
- Defined in:
- lib/martsearch/index_builder_utils.rb
Overview
Utility module containing helper funcions for the IndexBuilder class.
Instance Method Summary (collapse)
-
- (nil/String/Array) extract_value_to_index(attr_name, attribute_map, data_row_obj, mart_ds = nil)
Utility function to determine what data values we need to add to the index given the dataset configuration.
-
- (Object) index_concatenated_ontology_terms(concat_ont_term_conf, doc, data_row_obj, map_data, cache)
Utility function to split out and index ontology terms concatenated into a single string.
-
- (Object) index_extracted_attributes(extract_conf, doc, value_to_index)
Utility function to handle the extraction of metadata from indexed values, (i.e. MP terms in comments).
-
- (Object) index_grouped_attributes(grouped_attr_conf, doc, data_row_obj, map_data, mart_ds = nil)
Utility function to handle the indexing of grouped attributes.
-
- (Object) index_ontology_terms(ontology_term_conf, doc, data_row_obj, map_data, cache)
Utility function to handle the indexing of ontology terms.
-
- (Hash) new_document
Utility function to create a new Lucene/Solr document construct.
-
- (Object) open_daily_directory(cache_dir, delete = true)
Utility function to setup and move the current program into a daily cache directory.
-
- (Hash) process_attribute_map(attribute_map)
Utility function to process the attribute_map configuration into something we can use to map dataset results to our index configuration.
-
- (Object) setup_and_move_to_work_directory
Utility function to setup the expected IndexBuilder cache directory structure.
-
- (String) solr_document_xml(docs)
Utility function to create the actual XML markup for a collection of solr document constructs.
Instance Method Details
- (nil/String/Array) extract_value_to_index(attr_name, attribute_map, data_row_obj, mart_ds = nil)
Utility function to determine what data values we need to add to the index given the dataset configuration.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/martsearch/index_builder_utils.rb', line 114 def extract_value_to_index( attr_name, attribute_map, data_row_obj, mart_ds=nil ) = attribute_map[attr_name] value_to_index = data_row_obj[attr_name] if [:if_attr_equals] unless [:if_attr_equals].include?( value_to_index ) value_to_index = nil end end if [:index_attr_name] and mart_ds != nil if value_to_index mart_attributes = mart_ds.attributes() if [:index_attr_display_name_only] value_to_index = mart_attributes[attr_name].display_name else value_to_index = [ attr_name, mart_attributes[attr_name].display_name ] end end end if [:if_other_attr_indexed] other_attr = [:if_other_attr_indexed] other_attr_value = data_row_obj[ other_attr ] unless extract_value_to_index( other_attr, attribute_map, data_row_obj ) value_to_index = nil end end unless value_to_index.nil? if [:attr_prepend] value_to_index = "#{[:attr_prepend]}#{value_to_index}" end if [:attr_append] value_to_index = "#{value_to_index}#{[:attr_append]}" end end return value_to_index end |
- (Object) index_concatenated_ontology_terms(concat_ont_term_conf, doc, data_row_obj, map_data, cache)
Utility function to split out and index ontology terms concatenated into a single string.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/martsearch/index_builder_utils.rb', line 238 def index_concatenated_ontology_terms( concat_ont_term_conf, doc, data_row_obj, map_data, cache ) attribute = concat_ont_term_conf[:attr] split_delimiter = concat_ont_term_conf[:split_on] || ", " value_to_index = extract_value_to_index( attribute, map_data[:attribute_map], { attribute => data_row_obj[attribute] } ) if value_to_index && !value_to_index.gsub(" ","").empty? terms_to_test = value_to_index.split(split_delimiter) terms_to_test.each do |test_term| concat_ont_term_conf[:ontologies].each do |ontology_matcher,ontology_conf| regexp = Regexp.new( ontology_matcher.to_s, Regexp::IGNORECASE ) matcher = test_term.upcase.match( regexp ) unless matcher.nil? matched_term = matcher.to_s cached_data = cache[matched_term] term_conf = { :attr => attribute, :idx => { :term => ontology_conf[:term], :term_name => ontology_conf[:term_name], :breadcrumb => ontology_conf[:breadcrumb] } } if cached_data.nil? index_ontology_terms_from_fresh( doc, term_conf, matched_term, cache ) else index_ontology_terms_from_cache( doc, term_conf, cached_data ) end end end end end end |
- (Object) index_extracted_attributes(extract_conf, doc, value_to_index)
Utility function to handle the extraction of metadata from indexed values, (i.e. MP terms in comments).
162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/martsearch/index_builder_utils.rb', line 162 def index_extracted_attributes( extract_conf, doc, value_to_index ) regexp = Regexp.new( extract_conf[:regexp] ) matches = false if value_to_index.is_a?(Array) value_to_index.each do |value| matches = regexp.match( value ) if matches then doc[ extract_conf[:idx].to_sym ].push( matches[0] ) end end else matches = regexp.match( value_to_index ) if matches then doc[ extract_conf[:idx].to_sym ].push( matches[0] ) end end end |
- (Object) index_grouped_attributes(grouped_attr_conf, doc, data_row_obj, map_data, mart_ds = nil)
Utility function to handle the indexing of grouped attributes
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/martsearch/index_builder_utils.rb', line 184 def index_grouped_attributes( grouped_attr_conf, doc, data_row_obj, map_data, mart_ds=nil ) grouped_attr_conf.each do |group| attrs = [] group[:attrs].each do |attribute| value_to_index = extract_value_to_index( attribute, map_data[:attribute_map], { attribute => data_row_obj[attribute] }, mart_ds ) # When we have an attribute that we're indexing the attribute NAME # of, we get an array returned... We can only pick one, so let's pick # the biomart display name... if value_to_index.is_a?(Array) then value_to_index = value_to_index.pop() end if value_to_index and !value_to_index.gsub(" ","").empty? attrs.push(value_to_index) end end # Only index when we have values for ALL the grouped attributes if !attrs.empty? and ( attrs.size() === group[:attrs].size() ) join_str = group[:using] ? group[:using] : "||" doc[ group[:idx].to_sym ].push( attrs.join(join_str) ) end end end |
- (Object) index_ontology_terms(ontology_term_conf, doc, data_row_obj, map_data, cache)
Utility function to handle the indexing of ontology terms.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/martsearch/index_builder_utils.rb', line 215 def index_ontology_terms( ontology_term_conf, doc, data_row_obj, map_data, cache ) ontology_term_conf.each do |term_conf| attribute = term_conf[:attr] value_to_index = extract_value_to_index( attribute, map_data[:attribute_map], { attribute => data_row_obj[attribute] } ) if value_to_index && !value_to_index.gsub(" ","").empty? cached_data = cache[value_to_index] if cached_data.nil? index_ontology_terms_from_fresh( doc, term_conf, value_to_index, cache ) else index_ontology_terms_from_cache( doc, term_conf, cached_data ) end end end end |
- (Hash) new_document
Utility function to create a new Lucene/Solr document construct.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/martsearch/index_builder_utils.rb', line 51 def new_document index_config = MartSearch::Controller.instance().config[:index] # Work out fields to ignore - these will be auto populated by Solr copy_fields = [] index_config[:schema][:copy_fields].each do |copy_field| copy_fields.push( copy_field[:dest] ) end doc = {} index_config[:schema][:fields].each do |key,detail| doc[ key.to_sym ] = [] unless copy_fields.include?(key.to_s) end return doc end |
- (Object) open_daily_directory(cache_dir, delete = true)
Utility function to setup and move the current program into a daily cache directory.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/martsearch/index_builder_utils.rb', line 31 def open_daily_directory( cache_dir, delete=true ) setup_and_move_to_work_directory() Dir.chdir("#{MARTSEARCH_PATH}/tmp/index_builder/#{cache_dir}") daily_dir = "daily_#{Date.today.to_s}" system "/bin/rm -r #{daily_dir}" if File.directory?(daily_dir) and delete Dir.mkdir(daily_dir) if delete or !File.directory?(daily_dir) # clean up old daily directories directories = Dir.glob("daily_*").sort while directories.size > 5 system("/bin/rm -rf '#{directories.shift}'") end Dir.chdir(daily_dir) end |
- (Hash) process_attribute_map(attribute_map)
Utility function to process the attribute_map configuration into something we can use to map dataset results to our index configuration.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/martsearch/index_builder_utils.rb', line 72 def process_attribute_map( attribute_map ) map = {} primary_attribute = nil map_to_index_field = nil # Extract all of the needed index mapping data from the "attribute_map" # - The "attribute_map" defines how the biomart attributes relate to the index "fields" # - The "primary_attribute" is the biomart attribute used to associate a set of biomart # results to an index "doc" - using the "map_to_index_field" field as the link. attribute_map.each do |mapping_obj| if mapping_obj[:use_to_map] if primary_attribute raise "You have defined more than one attribute to map to the index with! Please check your config..." else primary_attribute = mapping_obj[:attr] map_to_index_field = mapping_obj[:idx].to_sym end end map[ mapping_obj[:attr] ] = mapping_obj map[ mapping_obj[:attr] ][:idx] = map[ mapping_obj[:attr] ][:idx].to_sym end unless primary_attribute raise "You have not specified an attribute to map to the index with! Please check your config..." end return { :attribute_map => map, :primary_attribute => primary_attribute, :map_to_index_field => map_to_index_field } end |
- (Object) setup_and_move_to_work_directory
Utility function to setup the expected IndexBuilder cache directory structure.
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
# File 'lib/martsearch/index_builder_utils.rb', line 11 def setup_and_move_to_work_directory index_builder_tmpdir = "#{MARTSEARCH_PATH}/tmp/index_builder" Dir.mkdir(index_builder_tmpdir) unless File.directory?(index_builder_tmpdir) Dir.chdir(index_builder_tmpdir) ['dataset_dowloads','document_cache','solr_xml'].each do |cache_dir| Dir.mkdir(cache_dir) unless File.directory?(cache_dir) if cache_dir == 'dataset_dowloads' Dir.chdir(cache_dir) Dir.mkdir('current') unless File.directory?('current') Dir.chdir('..') end end end |
- (String) solr_document_xml(docs)
Utility function to create the actual XML markup for a collection of solr document constructs.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/martsearch/index_builder_utils.rb', line 278 def solr_document_xml( docs ) solr_xml = "" xml = Builder::XmlMarkup.new( :target => solr_xml, :indent => 2 ) xml.add { docs.each do |doc| xml.doc { doc.each do |field,field_terms| field_terms.each do |term| xml.field( term, :name => field ) end end } end } return solr_xml end |