Class: Geoblacklight::References

Inherits:
Object
  • Object
show all
Defined in:
lib/geoblacklight/references.rb

Overview

References is a geoblacklight-schema dct:references parser

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, reference_field = Settings.FIELDS.REFERENCES) ⇒ References

Returns a new instance of References.



5
6
7
8
9
 
# File 'lib/geoblacklight/references.rb', line 5

def initialize(document, reference_field = Settings.FIELDS.REFERENCES)
  @document = document
  @reference_field = reference_field
  @refs = parse_references.map { |ref| Reference.new(ref) }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args, &b) ⇒ Object (private)

Adds a call to references for defined URI keys



116
117
118
119
120
121
122
 
# File 'lib/geoblacklight/references.rb', line 116

def method_missing(m, *args, &b)
  if Geoblacklight::Constants::URI.key?(m)
    references m
  else
    super
  end
end

Instance Attribute Details

#reference_field ⇒ Object (readonly)

Returns the value of attribute reference_field.



4
5
6
 
# File 'lib/geoblacklight/references.rb', line 4

def reference_field
  @reference_field
end

#refs ⇒ Object (readonly)

Returns the value of attribute refs.



4
5
6
 
# File 'lib/geoblacklight/references.rb', line 4

def refs
  @refs
end

Instance Method Details

#download_types ⇒ Hash?

Generated download types from wxs services

Returns:

  • (Hash, nil) 


66
67
68
 
# File 'lib/geoblacklight/references.rb', line 66

def download_types
  downloads_by_format
end

#downloads_by_format ⇒ Hash?

Download hash based off of format type

Returns:

  • (Hash, nil) 


52
53
54
55
56
57
58
59
60
61
 
# File 'lib/geoblacklight/references.rb', line 52

def downloads_by_format
  case format
  when 'Shapefile'
    vector_download_formats
  when 'GeoTIFF'
    geotiff_download_formats
  when 'ArcGRID'
    arcgrid_download_formats
  end
end

#format ⇒ String

Accessor for a document’s file format

Returns:

  • (String) —

    file format for the document



31
32
33
 
# File 'lib/geoblacklight/references.rb', line 31

def format
  @document[Settings.FIELDS.FILE_FORMAT]
end

#preferred_download ⇒ Hash?

Preferred download (should be a file download)

Returns:

  • (Hash, nil) 


45
46
47
 
# File 'lib/geoblacklight/references.rb', line 45

def preferred_download
  return file_download unless download.blank?
end

#references(ref_type) ⇒ Geoblacklight::Reference

Parameters:

  • ref_type (String, Symbol)

Returns:



38
39
40
 
# File 'lib/geoblacklight/references.rb', line 38

def references(ref_type)
  @refs.find { |reference| reference.type == ref_type }
end

#shown_metadata ⇒ Geoblacklight::Metadata::Base

Return only metadata for shown metadata

Returns:



24
25
26
 
# File 'lib/geoblacklight/references.rb', line 24

def shown_metadata
  @shown_metadata ||= shown_metadata_refs.map { |ref| Geoblacklight::Metadata.instance(ref) }
end

#shown_metadata_refs ⇒ Geoblacklight::Reference

Return only those metadata references which are exposed within the configuration

Returns:



14
15
16
17
18
19
 
# File 'lib/geoblacklight/references.rb', line 14

def shown_metadata_refs
  metadata = @refs.select { |ref| Settings.METADATA_SHOWN.include?(ref.type.to_s) }
  metadata.sort do |u, v|
    Settings.METADATA_SHOWN.index(u.type.to_s) <=> Settings.METADATA_SHOWN.index(v.type.to_s)
  end
end