adiwg-mdtranslator 1.3.0 → 1.4.0.beta1

data/lib/adiwg/mdtranslator/writers/mdJson/mdJson_writer.rb

@@ -0,0 +1,42 @@
+require 'jbuilder'
+require_relative 'version'
+require_relative 'sections/mdJson_contact'
+require_relative 'sections/mdJson_metadata'
+require_relative 'sections/mdJson_dictionary'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module MdJson
+                def self.startWriter(_intObj, responseObj, _paramsObj)
+                    #set output flag for null properties
+                    Jbuilder::ignore_nil(!responseObj[:writerShowTags])
+                    # set the format of the output file based on the writer specified
+                    responseObj[:writerFormat] = 'mdJson'
+                    responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::MdJson::VERSION
+
+                    # version
+                    metadata = Jbuilder.new do |json|
+                        json.version do
+                            json.name 'mdJson'
+                            json.version responseObj[:writerVersion]
+                        end
+
+                        json.contact _intObj[:contacts].map { |obj| Contact.build(obj).attributes!}
+                        json.metadata Metadata.build(_intObj[:metadata])
+                        json.dataDictionary _intObj[:dataDictionary].map { |obj| Dictionary.build(obj).attributes!}
+                    end
+
+                    # set writer pass to true if no messages
+                    # false or warning will be set by code that places the message
+                    responseObj[:writerPass] = true if responseObj[:writerMessages].empty?
+
+                    # j = JSON.parse(metadata.target!)
+                    # puts JSON.pretty_generate(j)
+
+                    metadata.target!
+                end
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/readme.md

@@ -0,0 +1,19 @@
+
+## mdJson
+
+### Supported versions
+
+> 1.1.x
+
+### Writer for ADIwg JSON metadata format (mdJson)
+
+The mdJson format is a simple JSON format for documenting and exchanging information
+about scientific projects and data.  The Alaska Data Integration working group (ADIwg) wrote the
+standard to support translation to complex standards such as the ISO 19115-2 Geographic Metadata standard
+and FGDC's Content Standard for Digital Geospatial Metadata.  The mdJson standard
+remains independent of any published standards while comprehensive enough to support translation
+to many. The mdJson standard is also a convenient format to exchange directly with other organizations as
+the JSON structure is easier create and ingest by programming languages.
+
+The mdJson format is fully documented on the interactive
+[mdTools](http://www.adiwg.org/mdTools) website.

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_additionalDoc.rb

@@ -0,0 +1,19 @@
+require 'jbuilder'
+require_relative 'mdJson_citation'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module AdditionalDoc
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.resourceType intObj[:resourceType]
+              json.citation Citation.build(intObj[:citation]) unless intObj[:citation].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_address.rb

@@ -0,0 +1,22 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Address
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.deliveryPoint(intObj[:deliveryPoints])
+              json.protocol intObj[:city]
+              json.name intObj[:adminArea]
+              json.description intObj[:postalCode]
+              json.function intObj[:country]
+              json.electronicMailAddress(intObj[:eMailList])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_associatedResource.rb

@@ -0,0 +1,22 @@
+require 'jbuilder'
+require_relative 'mdJson_citation'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module AssociatedResource
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.associationType intObj[:associationType]
+              json.initiativeType intObj[:initiativeType]
+              json.resourceType intObj[:resourceType]
+              json.resourceCitation Citation.build(intObj[:resourceCitation]) unless intObj[:resourceCitation].empty?
+              json.metadataCitation Citation.build(intObj[:metadataCitation]) unless intObj[:metadataCitation].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_attribute.rb

@@ -0,0 +1,27 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Attribute
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.commonName intObj[:attributeName]
+              json.codeName intObj[:attributeCode]
+              json.alias (intObj[:attributeAlias])
+              json.definition intObj[:attributeDefinition]
+              json.dataType intObj[:dataType]
+              json.allowNull intObj[:allowNull]
+              json.units intObj[:unitOfMeasure]
+              json.domainId intObj[:domainId]
+              json.minValue intObj[:minValue]
+              json.maxValue intObj[:maxValue]
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_base.rb

@@ -0,0 +1,19 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Base
+          def json_map(collection = [], _class)
+            if collection.nil? || collection.empty?
+              return nil
+            else
+              collection.map { |item| _class.build(item).attributes! }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_citation.rb

@@ -0,0 +1,33 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_resourceIdentifier'
+require_relative 'mdJson_onlineResource'
+require_relative 'mdJson_dateTime'
+require_relative 'mdJson_responsibleParty'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Citation
+          extend MdJson::Base
+
+          def self.build(cite)
+            unless cite.nil? || cite.empty?
+              Jbuilder.new do |json|
+                json.title cite[:citTitle]
+                json.alternateTitle cite[:citAltTitle]
+                json.date json_map(cite[:citDate], DateTime)
+                json.edition cite[:citEdition]
+                json.identifier json_map(cite[:citResourceIds], ResourceIdentifier)
+                json.responsibleParty json_map(cite[:citResponsibleParty], ResponsibleParty)
+                json.presentationForm(cite[:citResourceForms]) unless cite[:citResourceForms].empty?
+                json.onlineResource json_map(cite[:citOlResources], OnlineResource)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_constraint.rb

@@ -0,0 +1,28 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Constraint
+          def self.build(use, legal, security)
+            Jbuilder.new do |json|
+              json.useLimitation(use)
+              json.legalConstraint(legal) do |lg|
+                json.accessConstraint(lg[:accessCodes])
+                json.useConstraint(lg[:useCodes])
+                json.otherConstraint(lg[:otherCons])
+              end
+              json.securityConstraint(security) do |sc|
+                json.classification sc[:classCode]
+                json.userNote sc[:userNote]
+                json.classificationSystem sc[:classSystem]
+                json.handlingDescription sc[:handlingDesc]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_contact.rb

@@ -0,0 +1,31 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_onlineResource'
+require_relative 'mdJson_phone'
+require_relative 'mdJson_address'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Contact
+          extend MdJson::Base
+
+          def self.build(contact)
+            Jbuilder.new do |json|
+              # contact
+              json.contactId contact[:contactId]
+              json.individualName contact[:indName]
+              json.organizationName contact[:orgName]
+              json.positionName contact[:position]
+              json.onlineResource json_map(contact[:onlineRes], OnlineResource)
+              json.contactInstructions contact[:contactInstructions]
+              json.phoneBook json_map(contact[:phones], Phone)
+              json.address Address.build(contact[:address])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_coverageInfo.rb

@@ -0,0 +1,30 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_resourceIdentifier'
+require_relative 'mdJson_coverageItem'
+require_relative 'mdJson_imageInfo'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module CoverageInfo
+          extend MdJson::Base
+
+          def self.build(intObj)
+            unless intObj.empty?
+              Jbuilder.new do |json|
+                json.coverageType intObj[:coverageType]
+                json.coverageName intObj[:coverageName]
+                json.coverageDescription intObj[:coverageDescription]
+                json.processingLevel ResourceIdentifier.build(intObj[:processingLevel]) unless intObj[:processingLevel].empty?
+                json.coverageItem json_map(intObj[:coverageItems], CoverageItem)
+                json.imageInfo ImageInfo.build(intObj[:imageInfo]) unless intObj[:imageInfo].empty?
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_coverageItem.rb

@@ -0,0 +1,44 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module CoverageItem
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.itemName intObj[:itemName]
+              json.itemType intObj[:itemType]
+              json.itemDescription intObj[:itemDescription]
+              json.minValue intObj[:minValue]
+              json.maxValue intObj[:maxValue]
+              json.units intObj[:units]
+              json.scaleFactor intObj[:scaleFactor]
+              json.offset intObj[:offset]
+              json.meanValue intObj[:meanValue]
+              json.standardDeviation intObj[:standardDeviation]
+              json.bitsPerValue intObj[:bitsPerValue]
+              json.classifiedData do
+                cd = intObj[:classedData]
+                json.numberOfClasses cd[:numberOfClasses]
+                json.classifiedDataItem(cd[:classedDataItems]) do |cdi|
+                  json.className cdi[:className]
+                  json.classDescription cdi[:classDescription]
+                  json.classValue cdi[:classValue]
+                end
+              end unless intObj[:classedData].empty?
+              json.sensorInfo do
+                si = intObj[:sensorInfo]
+                json.toneGradations si[:toneGradations]
+                json.sensorMin si[:sensorMin]
+                json.sensorMax si[:sensorMax]
+                json.sensorUnits si[:sensorUnits]
+                json.sensorPeakResponse si[:sensorPeakResponse]
+              end unless intObj[:sensorInfo].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_dataQuality.rb

@@ -0,0 +1,32 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_citation'
+require_relative 'mdJson_processStep'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module DataQuality
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.scope intObj[:dataScope]
+              json.lineage do
+                  ln = intObj[:dataLineage]
+                  json.statement ln[:statement]
+                  json.processStep json_map(ln[:processSteps], ProcessStep)
+                  json.source(ln[:dataSources]) do |src|
+                      json.description src[:sourceDescription]
+                      json.citation Citation.build(src[:sourceCitation]) unless src[:sourceCitation].empty?
+                      json.processStep json_map(src[:sourceSteps], ProcessStep) unless src[:sourceSteps].empty?
+                  end unless ln[:dataSources].empty?
+              end unless intObj[:dataLineage].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_dateTime.rb

@@ -0,0 +1,18 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module DateTime
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.date(intObj[:dateTime])
+              json.dateType intObj[:dateType]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_dictionary.rb

@@ -0,0 +1,33 @@
+require 'jbuilder'
+
+require_relative 'mdJson_base'
+require_relative 'mdJson_citation'
+require_relative 'mdJson_domain'
+require_relative 'mdJson_entity'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Dictionary
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.dictionaryInfo do
+                  dict = intObj[:dictionaryInfo]
+                  json.citation Citation.build(dict[:dictCitation])
+                  json.resourceType dict[:dictResourceType]
+                  json.description dict[:dictDescription]
+                  json.language dict[:dictLanguage]
+                  json.includedWithDataset dict[:includedWithDataset]
+              end unless intObj[:dictionaryInfo].empty?
+              json.domain json_map(intObj[:domains], Domain)
+              json.entity json_map(intObj[:entities], Entity)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_distributionInfo.rb

@@ -0,0 +1,31 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_responsibleParty'
+require_relative 'mdJson_format'
+require_relative 'mdJson_transferOption'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module DistributionInfo
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.distributorContact ResponsibleParty.build(intObj[:distContact])
+              json.distributionOrderProcess(intObj[:distOrderProcs]) do |dpo|
+                json.fees dpo[:fees]
+                json.plannedAvailabilityDateTime dpo[:plannedDateTime][:dateTime] unless dpo[:plannedDateTime].nil?
+                json.orderingInstructions dpo[:orderInstructions]
+                json.turnaround dpo[:turnaround]
+            end unless intObj[:distOrderProcs].empty?
+              json.distributorFormat json_map(intObj[:distFormats], Format)
+              json.distributorTransferOptions json_map(intObj[:distTransOptions], TransferOption)
+            end
+          end
+        end
+      end
+    end
+  end
+end