Sha256: 4089aad25f6ec9918dcfebc30d1793bc89480460b269ae42b9c20d03c68e9896

Contents?: true

Size: 2 KB

Versions: 19

Compression:

Stored size: 2 KB

Contents

# frozen_string_literal: true
module Blacklight::Document
  module SemanticFields
    extend ActiveSupport::Concern

    module ClassMethods
      # Returns array of hashes of registered extensions. Each hash
      # has a :module_obj key and a :condition_proc key. Usually this
      # method is only used internally in #apply_extensions, but if you
   
      # Class-level method for accessing/setting semantic mappings
      # for solr stored fields. Can be set by local app, key is
      # a symbol for a semantic, value is a solr _stored_ field.
      #
      # Stored field can be single or multi-value. In some cases
      # clients may only use the first value from a multi-value field.
      #
      # Currently documented semantic tokens, not all may be
      # used by core BL, but some may be used by plugins present
      # or future. 
      # :title, :author, :year, :language => User-presentable strings. 
      def field_semantics
        @field_semantics ||= {}
      end  
    end
    
    # Returns a hash keyed by semantic tokens, value is an array of
    # strings. (Array to handle multi-value fields). If no value(s)
    # available, empty array is returned. 
    #
    # Default implementation here uses field_semantics
    # to just take values from Solr stored fields. 
    # Extensions can over-ride this method to provide better/different lookup,
    # but extensions should call super and modify hash returned, to avoid
    # unintentionally erasing values provided by other extensions. 
    def to_semantic_values
      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_names), hash|
        ##
        # Handles single string field_name or an array of field_names
        value = Array.wrap(field_names).map { |field_name| self[field_name] }.flatten.compact

        # Make single and multi-values all arrays, so clients
        # don't have to know.
        hash[key] = value unless value.empty?
      end

      @semantic_value_hash ||= {}
    end    
  end
end

Version data entries

19 entries across 19 versions & 1 rubygems

Version Path
blacklight-6.25.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.24.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.23.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.22.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.21.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.20.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.19.2 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.19.1 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.19.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.18.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.17.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.16.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.15.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.14.1 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.14.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.13.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.12.0 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.11.2 app/models/concerns/blacklight/document/semantic_fields.rb
blacklight-6.11.1 app/models/concerns/blacklight/document/semantic_fields.rb