Module: ADIWG::Mdtranslator::Readers

Defined in:
lib/adiwg/mdtranslator/readers/mdReaders.rb,
lib/adiwg/mdtranslator/readers/fgdc/version.rb,
lib/adiwg/mdtranslator/readers/sbJson/version.rb,
lib/adiwg/mdtranslator/readers/fgdc/fgdc_reader.rb,
lib/adiwg/mdtranslator/readers/mdJson/mdJson_reader.rb,
lib/adiwg/mdtranslator/readers/sbJson/sbJson_reader.rb,
lib/adiwg/mdtranslator/readers/mdJson/mdJson_validator.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_date.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_fgdc.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_id.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_range.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_tag.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_entity.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_raster.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_series.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_source.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_date.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_body.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_date.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_codeSet.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_contact.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_keyword.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_lineage.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_process.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_quality.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_party.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_phone.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_scope.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_citation.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_dateTime.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_security.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonomy.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_domain.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_entity.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_extent.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_format.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_locale.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_mdJson.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_medium.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_schema.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_series.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_source.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_budget.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_extent.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_rights.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_sbJson.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_titles.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_attribute.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_address.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_contact.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_funding.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geoJson.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_graphic.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_keyword.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_lineage.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_measure.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_voucher.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_contact.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_project.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_purpose.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_spatial.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_enumerated.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonClass.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_timePeriod.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_citation.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_dateTime.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_duration.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geodetic.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadata.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_taxonomy.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_citation.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_parentId.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_digitalForm.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_geologicAge.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_localPlanar.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_localSystem.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_methodology.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_pointVector.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_publication.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonSystem.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_timeInstant.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_algorithm.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_attribute.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_dimension.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_codelists.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_distribution.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_metadataInfo.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_onlineOption.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_orderProcess.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_transferInfo.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_allocation.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_constraint.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_domainItem.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_identifier.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_processing.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_timePeriod.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_valueRange.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_identifier.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_provenance.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/gridSystems/grid_ups.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/gridSystems/grid_utm.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_mapGridSystem.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_mapProjection.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_offlineOption.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialDomain.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_verticalDatum.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_verticalDepth.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_boundingBox.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_dataQuality.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_distributor.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityIndex.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geologicAge.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_maintenance.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_processStep.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_timeInstant.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_publication.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_relatedItem.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_entityOverview.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_identification.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_onlineResource.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_responsibility.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_distribution.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataInfo.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_orderProcess.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_resourceInfo.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_resourceType.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_timeInterval.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_vectorObject.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/gridSystems/grid_other.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_entityAttribute.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_keywordObject.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_processReport.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_releasability.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_resourceUsage.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_verticalDatum.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_horizontalPlanar.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialReference.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_verticalAltitude.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_attributeGroup.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_coverageResult.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_dataDictionary.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryObject.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_onlineResource.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_temporalExtent.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_transferOption.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_verticalExtent.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_browseCategory.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_webLinkGraphic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_geodeticReference.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityAttribute.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryFeature.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_legalConstraint.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_localProjection.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_taxonomicSystem.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_materialRequest.rb,
lib/adiwg/mdtranslator/readers/sbJson/modules/module_webLinkDocument.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_entityForeignKey.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_evaluationMethod.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geographicExtent.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_imageDescription.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_obliqueLinePoint.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_responsibleParty.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_scopeDescription.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_spatialReference.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_horizontalReference.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialOrganization.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_conformanceResult.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_dataQualityReport.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_descriptiveResult.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_featureCollection.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_nominalResolution.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_spatialResolution.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/gridSystems/grid_statePlane.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_geographicResolution.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/module_planarCoordinateInfo.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_associatedResource.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_contactPostprocess.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryCollection.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geometryProperties.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_gridRepresentation.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataRepository.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_quantitativeResult.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_securityConstraint.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_coverageDescription.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_coordinateResolution.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_geographicResolution.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_projectionParameters.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_vectorRepresentation.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_spatialRepresentation.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/gridSystems/grid_equalArcSecond.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_albers.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_common.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_additionalDocumentation.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_rangeElementDescription.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_taxonomicClassification.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_gnomonic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_mercator.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_robinson.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_bearingDistanceResolution.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_referenceSystemParameters.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_polyconic.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_georectifiedRepresentation.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_parameters.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_sinusoidal.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_polarStereo.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_lambertConic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_orthographic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_spaceOblique.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_stereographic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_vanDerGrinten.rb,
lib/adiwg/mdtranslator/readers/mdJson/modules/module_georeferenceableRepresentation.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_millerCylinder.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_modifiedAlaska.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_equirectangular.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_generalVertical.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_obliqueMercator.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_equidistantConic.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_lambertEqualArea.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_azimuthEquidistant.rb,
lib/adiwg/mdtranslator/readers/fgdc/modules/mapProjections/projection_transverseMercator.rb

Defined Under Namespace

Modules: Fgdc, MdJson, SbJson

Class Method Summary collapse

Class Method Details

.get_reader_readme(reader) ⇒ Object

return reader readme text this is called from the Rails API



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/adiwg/mdtranslator/readers/mdReaders.rb', line 56

def self.get_reader_readme(reader)

   thisDir = File.dirname(File.expand_path(__FILE__))
   path = File.join(thisDir, reader, 'readme.md')
   if File.exist?(path)
      file = File.open(path, 'r')
      readmeText = file.read
      file.close
      return readmeText
   else
      return 'Readme file not found'
   end

end

.handleReader(file, hResponseObj) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/adiwg/mdtranslator/readers/mdReaders.rb', line 15

def self.handleReader(file, hResponseObj)

   # use ':readerRequested' from hResponseObj to build directory path to reader
   # reader's high level folder must be placed in 'lib/adiwg/mdtranslator/readers/'
   # reader's code must must be in folder named '{reader}'
   # '{reader}' must contain a module named '{reader}_reader.rb'
   # '{reader}_reader.rb' must have a method named 'readFile()'
   # 'readFile()' must pass two parameters (file, hResponseObj)
   # all reader modules and classes must remain in their private namespace
   # reader namespace is 'ADIWG::Mdtranslator::Readers::{reader}'

   # reader high-level folder
   thisDir = File.dirname(File.expand_path(__FILE__))
   readerDir = File.join(thisDir, hResponseObj[:readerRequested])
   if File.directory?(readerDir)

      # reader folder
      readerModule = File.join(readerDir, hResponseObj[:readerRequested] + '_reader')
      require readerModule

      # reader namespace
      readerNS = hResponseObj[:readerRequested].dup
      readerNS[0] = readerNS[0].upcase

      # reader will create and return the intObj
      return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, hResponseObj)

   else

      hResponseObj[:readerValidationMessages] << "ERROR: Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
      hResponseObj[:readerValidationPass] = false

      # return empty intObj
      return {}

   end

end