adiwg-mdtranslator 1.3.0 → 1.4.0.beta1

data/lib/adiwg/mdtranslator/internal/module_lineString.rb

@@ -0,0 +1,18 @@
+# unpack line string
+# line string is coded in GeoJSON
+module ADIWG
+    module Mdtranslator
+        module LineString
+            def self.unpack(aCoords, geoType, _responseObj)
+                intMetadataClass = InternalMetadata.new
+                intLine = intMetadataClass.newGeometry
+
+                intLine[:geoType] = geoType
+                intLine[:geometry] = aCoords
+                intLine[:dimension] = AdiwgCoordinates.getDimension(aCoords)
+
+                intLine
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/internal/module_point.rb

@@ -0,0 +1,18 @@
+# unpack point
+# point is coded in GeoJSON
+module ADIWG
+    module Mdtranslator
+        module Point
+            def self.unpack(aCoords, geoType, _responseObj)
+                intMetadataClass = InternalMetadata.new
+                intPoint = intMetadataClass.newGeometry
+
+                intPoint[:geoType] = geoType
+                intPoint[:geometry] = aCoords
+                intPoint[:dimension] = AdiwgCoordinates.getDimension(aCoords)
+
+                intPoint
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_contacts.rb

@@ -129,12 +129,14 @@ module ADIWG
                         intCont = intMetadataClass.newContact
                         intCont[:contactId] = 'ADIwgBio'
                         intCont[:orgName] = 'National Biological Information Infrastructure (NBII)'
+                        intCont[:internal] = true
                         aDefContacts << intCont
 
                         # contact to support doi (digital object identifier)
                         intCont = intMetadataClass.newContact
                         intCont[:contactId] = 'ADIwgDOI'
                         intCont[:orgName] = 'International DOI Foundation (IDF)'
+                        intCont[:internal] = true
 
                         intOlRes = intMetadataClass.newOnlineResource
                         intOlRes[:olResURI] = 'http://www.doi.org'
@@ -151,4 +153,4 @@ module ADIWG
             end
         end
     end
-end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_geographicElement.rb

@@ -21,8 +21,8 @@
 require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_geoCoordSystem')
 require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_geoProperties')
 require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_boundingBox')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_point')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineString')
+#require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_point')
+#require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineString')
 require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_polygon')
 
 module ADIWG
@@ -50,6 +50,8 @@ module ADIWG
                             # find geographic element type
                             if hGeoJsonElement.has_key?('type')
                                 elementType = hGeoJsonElement['type']
+                                #store the original GeoJSON type
+                                hGeoElement[:elementType] = elementType
                             else
                                 # invalid geographic element
                                 return nil
@@ -72,20 +74,26 @@ module ADIWG
                             # set geographic element properties
                             if hGeoJsonElement.has_key?('properties')
                                 hGeoProps = hGeoJsonElement['properties']
-                                GeoProperties.unpack(hGeoProps, hGeoElement, responseObj)
+                                GeoProperties.unpack(hGeoProps, hGeoElement, responseObj) unless hGeoProps.nil?
                             end
 
                             # process geographic element bounding box
+                            # Only process Features with null geometry,
                             # the bounding box must be represented as a separate geographic element for ISO
                             # need to make a deep copy of current state of geographic element for bounding box
                             if hGeoJsonElement.has_key?('bbox')
                                 if hGeoJsonElement['bbox'].length == 4
                                     aBBox = hGeoJsonElement['bbox']
+                                    if  elementType == 'Feature' && hGeoJsonElement['geometry'].nil?
 
-                                    boxElement = Marshal.load(Marshal.dump(hGeoElement))
-                                    boxElement[:elementGeometry] = BoundingBox.unpack(aBBox, responseObj)
+                                        boxElement = Marshal.load(Marshal.dump(hGeoElement))
+                                        boxElement[:elementGeometry] = BoundingBox.unpack(aBBox, responseObj)
+                                        boxElement[:elementType] = 'BBOX'
 
-                                    aIntGeoEle << boxElement
+                                        aIntGeoEle << boxElement
+                                    end
+                                    # add bbox to element hash
+                                    hGeoElement[:bbox] = BoundingBox.unpack(aBBox, responseObj)
                                 end
                             end
 
@@ -107,9 +115,9 @@ module ADIWG
                                                     unless aCoordinates.empty?
                                                         case geometryType
                                                             when 'Point', 'MultiPoint'
-                                                                hGeoElement[:elementGeometry] = Point.unpack(aCoordinates, geometryType, responseObj)
+                                                                hGeoElement[:elementGeometry] = ADIWG::Mdtranslator::Point.unpack(aCoordinates, geometryType, responseObj)
                                                             when 'LineString', 'MultiLineString'
-                                                                hGeoElement[:elementGeometry] = LineString.unpack(aCoordinates, geometryType, responseObj)
+                                                                hGeoElement[:elementGeometry] = ADIWG::Mdtranslator::LineString.unpack(aCoordinates, geometryType, responseObj)
                                                             when 'Polygon', 'MultiPolygon'
                                                                 hGeoElement[:elementGeometry] = Polygon.unpack(aCoordinates, geometryType, responseObj)
                                                             else
@@ -139,12 +147,12 @@ module ADIWG
                                 # GeoJSON Geometries
                                 when 'Point', 'MultiPoint'
                                     aCoordinates = hGeoJsonElement['coordinates']
-                                    hGeoElement[:elementGeometry] = Point.unpack(aCoordinates, elementType, responseObj)
+                                    hGeoElement[:elementGeometry] = ADIWG::Mdtranslator::Point.unpack(aCoordinates, elementType, responseObj)
                                     aIntGeoEle << hGeoElement
 
                                 when 'LineString', 'MultiLineString'
                                     aCoordinates = hGeoJsonElement['coordinates']
-                                    hGeoElement[:elementGeometry] = LineString.unpack(aCoordinates, elementType, responseObj)
+                                    hGeoElement[:elementGeometry] = ADIWG::Mdtranslator::LineString.unpack(aCoordinates, elementType, responseObj)
                                     aIntGeoEle << hGeoElement
 
                                 when 'Polygon', 'MultiPolygon'

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_additionalDocumentation.rb

@@ -0,0 +1,52 @@
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_citation')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                module AdditionalDocumentation
+
+                    def self.unpack(hAddDoc, responseObj)
+
+                        # return nil object if input is empty
+                        intAddDoc = nil
+                        return if hAddDoc.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intAddDoc = intMetadataClass.newAdditionalDocumentation
+
+                        # additional documentation - resource type
+                        if hAddDoc.has_key?('resourceType')
+                            s = hAddDoc['resourceType']
+                            if s != ''
+                                intAddDoc[:resourceType] = s
+                            end
+                        end
+
+                        # additional documentation - resource citation
+                        if hAddDoc.has_key?('citation')
+                            hCitation = hAddDoc['citation']
+                            unless hCitation.empty?
+                                intAddDoc[:citation] = Citation.unpack(hCitation, responseObj)
+                            else
+                                responseObj[:readerExecutionMessages] << 'Additional documentation citation is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Additional documentation citation is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intAddDoc
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_boundingBox.rb

@@ -0,0 +1,54 @@
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                module BoundingBox
+
+                    def self.unpack(aBBox, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intGeometry = intMetadataClass.newGeometry
+                        intGeometry[:geoType] = 'BoundingBox'
+
+                        # unpack GeoJSON bounding box elements
+                        intBBox = intMetadataClass.newBoundingBox
+                        west = aBBox[0]
+                        south = aBBox[1]
+                        east = aBBox[2]
+                        north = aBBox[3]
+
+                        # validate coordinates if easting +/-180 and northing +/-90
+                        valid = false
+                        if (180 >= west) && (west >= -180)
+                            if (90 >= south) && (south >= -90)
+                                if (180 >= east) && (east >= -180)
+                                    if (90 >= north) &&(north >= -90)
+                                        valid = true
+                                    end
+                                end
+                            end
+                        end
+
+                        # build internal geo element if valid
+                        if valid
+                            intBBox[:westLong] = west
+                            intBBox[:eastLong] = east
+                            intBBox[:southLat] = south
+                            intBBox[:northLat] = north
+                            intGeometry[:geometry] = intBBox
+
+                            return intGeometry
+                        else
+                            return nil
+                        end
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_browseGraphic.rb

@@ -0,0 +1,66 @@
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                module BrowseGraphic
+
+                    def self.unpack(hBgraphic, responseObj)
+
+                        # return nil object if input is empty
+                        intBGraphic = nil
+                        return if hBgraphic.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intBGraphic = intMetadataClass.newBrowseGraphic
+
+                        # graphic - file name
+                        if hBgraphic.has_key?('fileName')
+                            s = hBgraphic['fileName']
+                            if s != ''
+                                intBGraphic[:bGName] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Graphic overview name is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Graphic overview name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # graphic - file description
+                        if hBgraphic.has_key?('fileDescription')
+                            s = hBgraphic['fileDescription']
+                            if s != ''
+                                intBGraphic[:bGDescription] = s
+                            end
+                        end
+
+                        # graphic - file  type
+                        if hBgraphic.has_key?('fileType')
+                            s = hBgraphic['fileType']
+                            if s != ''
+                                intBGraphic[:bGType] = s
+                            end
+                        end
+
+                        # graphic - web link
+                        if hBgraphic.has_key?('fileUri')
+                            s = hBgraphic['fileUri']
+                            if s != ''
+                                intBGraphic[:bGURI] = s
+                            end
+                        end
+
+                        return intBGraphic
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_citation.rb

@@ -0,0 +1,125 @@
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_onlineResource')
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_resourceIdentifier')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                module Citation
+
+                    def self.unpack(hCitation, responseObj)
+
+                        # return nil object if input is empty
+                        intCitation = nil
+                        return if hCitation.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intCitation = intMetadataClass.newCitation
+
+                        # citation - title
+                        if hCitation.has_key?('title')
+                            s = hCitation['title']
+                            if s != ''
+                                intCitation[:citTitle] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Citation title is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Citation title is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # citation - alternate title
+                        if hCitation.has_key?('alternateTitle')
+                            s = hCitation['alternateTitle']
+                            if s != ''
+                                intCitation[:citAltTitle] = s
+                            end
+                        end
+
+                        # citation - date
+                        if hCitation.has_key?('date')
+                            aCitDates = hCitation['date']
+                            unless aCitDates.empty?
+                                aCitDates.each do |hCitDate|
+                                    if hCitDate.has_key?('date')
+                                        s = hCitDate['date']
+                                        if s != ''
+                                            intDateTime = DateTime.unpack(s, responseObj)
+                                            if hCitDate.has_key?('dateType')
+                                                s = hCitDate['dateType']
+                                                if s != ''
+                                                    intDateTime[:dateType] = s
+                                                end
+                                            end
+                                            intCitation[:citDate] << intDateTime
+                                        end
+                                    end
+                                end
+                            end
+                        end
+
+                        # citation - edition
+                        if hCitation.has_key?('edition')
+                            s = hCitation['edition']
+                            if s != ''
+                                intCitation[:citEdition] = s
+                            end
+                        end
+
+                        # citation - responsible party
+                        if hCitation.has_key?('responsibleParty')
+                            aRParty = hCitation['responsibleParty']
+                            unless aRParty.empty?
+                                aRParty.each do |hRParty|
+                                    intCitation[:citResponsibleParty] << ResponsibleParty.unpack(hRParty, responseObj)
+                                end
+                            end
+                        end
+
+                        # citation - presentation form
+                        if hCitation.has_key?('presentationForm')
+                            aPForms = hCitation['presentationForm']
+                            unless aPForms.empty?
+                                aPForms.each do |pForm|
+                                    intCitation[:citResourceForms] << pForm
+                                end
+                            end
+                        end
+
+                        # citation - resource identifiers
+                        if hCitation.has_key?('identifier')
+                            aResIds = hCitation['identifier']
+                            aResIds.each do |hIdentifier|
+                                unless hIdentifier.empty?
+                                    intCitation[:citResourceIds] << ResourceIdentifier.unpack(hIdentifier, responseObj)
+                                end
+                            end
+                        end
+
+                        # citation - online resources
+                        if hCitation.has_key?('onlineResource')
+                            aOlRes = hCitation['onlineResource']
+                            aOlRes.each do |hOlRes|
+                                unless hOlRes.empty?
+                                    intCitation[:citOlResources] << OnlineResource.unpack(hOlRes, responseObj)
+                                end
+                            end
+                        end
+
+                        return intCitation
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_contacts.rb

@@ -0,0 +1,144 @@
+require 'uuidtools'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+                module Contact
+                    def self.unpack(hContact, responseObj)
+                        # return nil object if input is empty
+                        intCont = nil
+                        return if hContact.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intCont = intMetadataClass.newContact
+
+                        # contact ID - required
+                        # SB doesn't provide a contactId, so we create one
+                        intCont[:contactId] = UUIDTools::UUID.random_create.to_s
+                        hContact['contactId'] = intCont[:contactId]
+
+                        # contact name
+                        s = hContact['name']
+                        if s != ''
+                            if hContact['contactType'] == 'person'
+                                intCont[:indName] = s
+                                intCont[:orgName] = hContact['organization']['displayText']
+                            else
+                                intCont[:orgName] = s
+                            end
+                        end
+
+                        # position name
+                        if hContact.key?('jobTitle')
+                            s = hContact['jobTitle']
+                            intCont[:position] = s if s != ''
+                        end
+
+                        # SB Role, store the role for later lookup, not used
+                        # internally
+                        if hContact.key?('type')
+                            s = hContact['type']
+                            intCont[:sbType] = s if s != ''
+                        end
+
+                        # contact instructions
+                        if hContact.key?('instructions')
+                            s = hContact['instructions']
+                            intCont[:contactInstructions] = s if s != ''
+                        end
+
+                        if hContact.key?('primaryLocation')
+                            pl = hContact['primaryLocation']
+                            # phones - all service types
+                            if pl.key?('officePhone')
+                                officePhone = intMetadataClass.newPhone
+
+                                # phone - service
+                                officePhone[:phoneServiceType] = 'voice'
+                                officePhone[:phoneName] = 'officePhone'
+                                officePhone[:phoneNumber] = pl['officePhone']
+                                intCont[:phones] << officePhone
+                            end
+                            if pl.key?('faxPhone')
+                                faxPhone = intMetadataClass.newPhone
+
+                                # phone - service
+                                faxPhone[:phoneServiceType] = 'fax'
+                                faxPhone[:phoneName] = 'faxPhone'
+                                faxPhone[:phoneNumber] = pl['faxPhone']
+                                intCont[:phones] << faxPhone
+                            end
+
+                            # address
+                            address = pl['mailAddress']  || pl['streetAddress']
+                            unless address.nil?
+                                intAdd = intMetadataClass.newAddress
+
+                                # address - delivery point
+                                if address.has_key?('line1')
+                                  intAdd[:deliveryPoints] << address['line1']
+                                end
+
+                                if address.has_key?('line2')
+                                  intAdd[:deliveryPoints] << address['line2']
+                                end
+
+                                intAdd[:city] = address['city']
+                                intAdd[:adminArea] = address['state']
+                                intAdd[:postalCode] = address['zip']
+                                intAdd[:country] = address['country']
+
+                                if hContact['email']
+                                    intAdd[:eMailList] << hContact['email']
+                                end
+
+                                intCont[:address] = intAdd
+                            end
+                        end
+
+                        intCont
+                    end
+
+                    def self.setDefaultContacts
+                        # add default contacts
+                        intMetadataClass = InternalMetadata.new
+                        aDefContacts = []
+
+                        #contact for ScienceBase
+                        intCont = intMetadataClass.newContact
+                        intCont[:contactId] = 'SB'
+                        intCont[:orgName] = 'ScienceBase'
+
+                        intOlRes = intMetadataClass.newOnlineResource
+                        intOlRes[:olResURI] = 'http://www.sciencebase.gov'
+                        intOlRes[:olResName] = 'ScienceBase Homepage'
+                        intCont[:onlineRes] << intOlRes
+
+                        intAdd = intMetadataClass.newAddress
+                        intAdd[:eMailList] << 'sciencebase@usgs.gov'
+                        intCont[:address] = intAdd
+                        intCont[:internal] = true
+
+                        aDefContacts << intCont
+
+                        # contact to support doi (digital object identifier)
+                        intCont = intMetadataClass.newContact
+                        intCont[:contactId] = 'ADIwgDOI'
+                        intCont[:orgName] = 'International DOI Foundation (IDF)'
+
+                        intOlRes = intMetadataClass.newOnlineResource
+                        intOlRes[:olResURI] = 'http://www.doi.org'
+                        intCont[:onlineRes] << intOlRes
+                        intCont[:internal] = true
+
+                        aDefContacts << intCont
+
+                        aDefContacts
+                    end
+                end
+            end
+        end
+    end
+end