adiwg-mdtranslator 0.10.2 → 0.12.0

data/lib/adiwg/mdtranslator/writers/iso19110/class_FCfeatureCatalogue.rb

@@ -0,0 +1,174 @@
+# ISO 19110 <<Class>> FC_FeatureCatalogue
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-12-01 original script
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-12-29 set builder object '@xml' into string 'metadata'
+
+require 'class_responsibleParty'
+require 'class_featureType'
+
+class FC_FeatureCatalogue
+
+    def initialize(xml)
+        @xml = xml
+    end
+
+    def writeXML(internalObj)
+
+        # classes used
+        rPartyClass = $WriterNS::CI_ResponsibleParty.new(@xml)
+        featureClass = $WriterNS::FC_FeatureType.new(@xml)
+
+        intDataDictionary = internalObj[:dataDictionary]
+        hDDInfo = intDataDictionary[:dictionaryInfo]
+        aEntities = intDataDictionary[:entities]
+        hCitation = hDDInfo[:dictCitation]
+
+        $intContactList = internalObj[:contacts]
+        $domainList = intDataDictionary[:domains]
+
+        # document head
+        metadata = @xml.instruct! :xml, encoding: 'UTF-8'
+        @xml.comment!('core gfc based instance document for ISO 19110')
+        @xml.tag!('gfc:FC_FeatureCatalogue', {'xmlns:gmi' => 'http://www.isotc211.org/2005/gmi',
+                                              'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
+                                              'xmlns:gco' => 'http://www.isotc211.org/2005/gco',
+                                              'xmlns:gml' => 'http://www.opengis.net/gml/3.2',
+                                              'xmlns:gsr' => 'http://www.isotc211.org/2005/gsr',
+                                              'xmlns:gss' => 'http://www.isotc211.org/2005/gss',
+                                              'xmlns:gst' => 'http://www.isotc211.org/2005/gst',
+                                              'xmlns:gmx' => 'http://www.isotc211.org/2005/gmx',
+                                              'xmlns:gfc' => 'http://www.isotc211.org/2005/gfc',
+                                              'xmlns:xlink' => 'http://www.w3.org/1999/xlink',
+                                              'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                                              'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gfc ftp://ftp.ncddc.noaa.gov/pub/Metadata/Online_ISO_Training/Intro_to_ISO/schemas/ISObio/schema.xsd'}) do
+
+            # feature catalogue information - name - required
+            # name is pulled from citation title in data dictionary information section
+            s = nil
+            if hCitation
+                if hCitation[:citTitle]
+                    s = hCitation[:citTitle]
+                end
+            end
+            if !s.nil?
+                @xml.tag!('gmx:name') do
+                    @xml.tag!('gco:CharacterString', s)
+                end
+            else
+                @xml.tag!('gmx:name', {'gco:nilReason' => 'missing'})
+            end
+
+            # feature catalogue information - scope - required []
+            # only a single instance is being supported
+            s = hDDInfo[:dictResourceType]
+            if !s.nil?
+                @xml.tag!('gmx:scope') do
+                    @xml.tag!('gco:CharacterString', s)
+                end
+            else
+                @xml.tag!('gmx:scope', {'gco:nilReason' => 'missing'})
+            end
+
+            # feature catalogue information - field of application []
+            # only a single instance is being supported
+            s = hDDInfo[:dictDescription]
+            if !s.nil?
+                @xml.tag!('gmx:fieldOfApplication') do
+                    @xml.tag!('gco:CharacterString', s)
+                end
+            elsif $showAllTags
+                @xml.tag!('gmx:fieldOfApplication')
+            end
+
+            # feature catalogue information - version number - required
+            # version number is taken from citation citEdition in data dictionary the info section
+            s = nil
+            if hCitation
+                if hCitation[:citEdition]
+                    s = hCitation[:citEdition]
+                end
+            end
+            if !s.nil?
+                @xml.tag!('gmx:versionNumber') do
+                    @xml.tag!('gco:CharacterString', s)
+                end
+            else
+                @xml.tag!('gmx:versionNumber', {'gco:nilReason' => 'missing'})
+            end
+
+            # feature catalogue information - version date - required
+            # version number is taken from citation citEdition in data dictionary the info section
+            # citation allows an array of citation dates, only one can be used as version date
+            vDate = nil
+            if hCitation
+                if hCitation[:citDate]
+                    if hCitation[:citDate][0]
+                        hDate = hCitation[:citDate][0]
+                        unless hDate.empty?
+                            dateTime = hDate[:dateTime]
+                            dateRes = hDate[:dateResolution]
+                            unless dateTime.nil?
+                                vDate = AdiwgDateTimeFun.stringDateFromDateTime(dateTime, dateRes)
+                            end
+                        end
+                    end
+                end
+            end
+            if vDate.nil?
+                @xml.tag!('gmx:versionDate', {'gco:nilReason' => 'missing'})
+            else
+                @xml.tag!('gmx:versionDate') do
+                    @xml.tag!('gco:Date', vDate)
+                end
+            end
+
+            # feature catalogue information - language
+            s = hDDInfo[:dictLanguage]
+            if !s.nil?
+                @xml.tag!('gmx:language') do
+                    @xml.tag!('gco:CharacterString', s)
+                end
+            elsif $showAllTags
+                @xml.tag!('gmx:language')
+            end
+
+            # feature catalogue information - producer - required - CI_ResponsibleParty
+            # producer is taken from citation responsibleParty in data dictionary the info section
+            # citation allows an array of responsible parties, only one can be used as producer
+            rParty = nil
+            if hCitation
+                if hCitation[:citResponsibleParty]
+                    if hCitation[:citResponsibleParty][0]
+                        rParty = hCitation[:citResponsibleParty][0]
+                    end
+                end
+            end
+            if rParty.nil? || rParty.empty?
+                @xml.tag!('gfc:producer', {'gco:nilReason' => 'missing'})
+            else
+                @xml.tag!('gfc:producer') do
+                    rPartyClass.writeXML(rParty)
+                end
+            end
+
+            # feature catalogue feature type - required
+            # use feature type to represent entities
+            if !aEntities.empty?
+                aEntities.each do |hEntity|
+                    @xml.tag!('gfc:featureType') do
+                        featureClass.writeXML(hEntity)
+                    end
+                end
+            else
+                @xml.tag!('gfc:featureType', {'gco:nilReason' => 'missing'})
+            end
+
+            return metadata
+        end
+
+    end
+
+end

data/lib/adiwg/mdtranslator/writers/iso19110/iso19110_writer.rb

@@ -2,27 +2,56 @@
 
 # History:
 # 	Stan Smith 2014-12-01 original script
+#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/units'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/codelists'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/classes'))
 
 require 'builder'
 require 'date'
 require 'uuidtools'
-require 'class_FCfeatureCatalogue'
+require 'adiwg/mdtranslator/writers/iso19110/class_FCfeatureCatalogue'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso
+
+                # set writer namespace
+                $WriterNS = ADIWG::Mdtranslator::Writers::Iso
 
-$idCount = '_000'
+                class Iso19110
 
-class Iso19110Writer
+                    def initialize
+                        # reset ISO id='' counter
+                        $idCount = '_000'
+                    end
 
-	def initialize
-	end
+                    def writeXML(intObj)
 
-	def writeXML(internalObj)
+                        # set the format of the output file based on the writer specified
+                        $response[:writerFormat] = 'xml'
+                        $response[:writerVersion] = ADIWG::Mdtranslator::VERSION
 
-		# create new XML document
-		xml = Builder::XmlMarkup.new(indent: 3)
-		metadataWriter = FC_FeatureCatalogue.new(xml)
-		metadata = metadataWriter.writeXML(internalObj)
+                        # create new XML document
+                        xml = Builder::XmlMarkup.new(indent: 3)
+                        metadataWriter = FC_FeatureCatalogue.new(xml)
+                        metadata = metadataWriter.writeXML(intObj)
 
-		return metadata
-	end
+                        # set writer pass to true if no messages
+                        # false or warning will be set by code that places the message
+                        if $response[:writerMessages].length == 0
+                            $response[:writerPass] = true
+                        end
 
+                        return metadata
+                    end
+
+                end
+
+            end
+        end
+    end
 end
+

data/lib/adiwg/mdtranslator/writers/iso19115_2/class_MImetadata.rb

@@ -0,0 +1,347 @@
+# ISO 19115-2 <<Class>> MI_Metadata
+# writer output in XML
+
+# History:
+# 	Stan Smith 2013-08-09 original script
+# 	Stan Smith 2013-09-25 added distribution
+# 	Stan Smith 2013-09-25 added data quality
+# 	Stan Smith 2013-09-25 added metadata maintenance
+# 	Stan Smith 2013-09-25 added reference system info
+# 	Stan Smith 2013-12-27 added parent identifier
+#   Stan Smith 2014-05-14 modify for JSON schema 0.4.0
+#   Stan Smith 2014-05-14 refactored method calls to be consistent w/ other classes
+#   Stan Smith 2014-05-28 added resource URI
+#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#   Stan Smith 2014-08-18 add dataSetURI
+#   Stan Smith 2014-09-03 replaced spatial reference system code with named, epsg, and
+#   ... wkt reference system descriptions using RS_Identifier for 0.7.0
+#   Stan Smith 2014-09-19 changed file identifier to read from internal storage as
+#   ... an MD_Identifier class.  To support version 0.8.0 json.
+#   Stan Smith 2014-10-07 changed source of dataSetURI to
+#   ... metadata: {resourceInfo: {citation: {citOlResources[0]: {olResURI:}}}}
+#   Stan Smith 2014-10-10 modified to pass minimum metadata input test
+#   ... test were added to handle a missing metadata > metadataInfo block in the input
+#   Stan Smith 2014-11-06 changed hierarchy level to load values from resourceInfo > resourceType
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-12-29 set builder object '@xml' into string 'metadata'
+
+require 'code_characterSet'
+require 'code_scope'
+require 'class_responsibleParty'
+require 'class_metadataExtension'
+require 'class_dataIdentification'
+require 'class_distribution'
+require 'class_dataQuality'
+require 'class_maintenanceInformation'
+require 'class_referenceSystem'
+require 'module_dateTimeFun'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso
+
+                class MI_Metadata
+
+                    def initialize(xml)
+                        @xml = xml
+                    end
+
+                    def writeXML(internalObj)
+
+                        # classes used
+                        charCode = $WriterNS::MD_CharacterSetCode.new(@xml)
+                        scopeCode = $WriterNS::MD_ScopeCode.new(@xml)
+                        rPartyClass = $WriterNS::CI_ResponsibleParty.new(@xml)
+                        mdExtClass = $WriterNS::MD_MetadataExtensionInformation.new(@xml)
+                        dataIdClass = $WriterNS::MD_DataIdentification.new(@xml)
+                        distClass = $WriterNS::MD_Distribution.new(@xml)
+                        dqClass = $WriterNS::DQ_DataQuality.new(@xml)
+                        metaMaintClass = $WriterNS::MD_MaintenanceInformation.new(@xml)
+                        refSysClass = $WriterNS::MD_ReferenceSystem.new(@xml)
+
+                        intMetadata = internalObj[:metadata]
+                        hMetaInfo = intMetadata[:metadataInfo]
+                        hResInfo = intMetadata[:resourceInfo]
+                        aAssocRes = intMetadata[:associatedResources]
+                        $intContactList = internalObj[:contacts]
+
+                        # document head
+                        metadata = @xml.instruct! :xml, encoding: 'UTF-8'
+                        @xml.comment!('core gmi based instance document ISO 19115-2')
+                        @xml.tag!('gmi:MI_Metadata', {'xmlns:gmi' => 'http://www.isotc211.org/2005/gmi',
+                                                      'xmlns:gmd' => 'http://www.isotc211.org/2005/gmd',
+                                                      'xmlns:gco' => 'http://www.isotc211.org/2005/gco',
+                                                      'xmlns:gml' => 'http://www.opengis.net/gml/3.2',
+                                                      'xmlns:gsr' => 'http://www.isotc211.org/2005/gsr',
+                                                      'xmlns:gss' => 'http://www.isotc211.org/2005/gss',
+                                                      'xmlns:gst' => 'http://www.isotc211.org/2005/gst',
+                                                      'xmlns:gmx' => 'http://www.isotc211.org/2005/gmx',
+                                                      'xmlns:gfc' => 'http://www.isotc211.org/2005/gfc',
+                                                      'xmlns:srv' => 'http://www.isotc211.org/2005/srv',
+                                                      'xmlns:xlink' => 'http://www.w3.org/1999/xlink',
+                                                      'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                                                      'xsi:schemaLocation' => 'http://www.isotc211.org/2005/gmi ftp://ftp.ncddc.noaa.gov/pub/Metadata/Online_ISO_Training/Intro_to_ISO/schemas/ISObio/schema.xsd'}) do
+
+                            # metadata information - file identifier - default
+                            # the internal object stores the file identifier as a MD_Identifier to support 19115-1
+                            # hMetaInfo => metadata > metadataInfo
+                            # hMetaInfo[:metadataId] => MD_Identifier
+                            # ISO 19115-2 only support the file identifier as a character string
+                            @xml.tag!('gmd:fileIdentifier') do
+                                s = nil
+                                if hMetaInfo
+                                    if hMetaInfo[:metadataId]
+                                        s = hMetaInfo[:metadataId][:identifier]
+                                        unless s.nil?
+                                            @xml.tag!('gco:CharacterString', s)
+                                        end
+                                    end
+                                end
+                                if s.nil?
+                                    # generate fileIdentifier if one not provided
+                                    @xml.tag!('gco:CharacterString', UUIDTools::UUID.random_create.to_s)
+                                end
+                            end
+
+                            # metadata information - file language - default
+                            @xml.tag!('gmd:language') do
+                                # all xml is written in US English
+                                @xml.tag!('gco:CharacterString', 'eng; USA')
+                            end
+
+                            # metadata information - character set - default
+                            @xml.tag!('gmd:characterSet') do
+                                # all out put is in utf8
+                                charCode.writeXML('utf8')
+                            end
+
+                            # metadata information - parent identifier
+                            # the internal object stores the parent identifier as a CI_Citation to support 19115-1
+                            # hMetaInfo => metadata > metadataInfo
+                            # hMetaInfo[:parentMetadata] => hParent => CI_Citation
+                            # ISO 19115-2 only support the parent identifier as a character string
+                            s = nil
+                            if hMetaInfo
+                                if hMetaInfo[:parentMetadata]
+                                    hParent = hMetaInfo[:parentMetadata]
+                                    if !hParent.empty?
+                                        s = hParent[:citTitle]
+                                        aResIds = hParent[:citResourceIds]
+                                        if aResIds.length > 0
+                                            s += ' ids: | '
+                                            aResIds.each do |resource|
+                                                s += resource[:identifierType] + ': ' + resource[:identifier] + ' | '
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                            if !s.nil?
+                                @xml.tag!('gmd:parentIdentifier') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            elsif $showAllTags
+                                @xml.tag!('gmd:parentIdentifier')
+                            end
+
+                            # metadata information - hierarchy level - defaults to 'dataset',
+                            # values taken from resourceInfo > resourceType
+                            fileHierarchy = false
+                            s = hResInfo[:resourceType]
+                            if s != ''
+                                fileHierarchy = true
+                                @xml.tag!('gmd:hierarchyLevel') do
+                                    scopeCode.writeXML(s)
+                                end
+                            end
+                            if !fileHierarchy
+                                @xml.tag!('gmd:hierarchyLevel') do
+                                    scopeCode.writeXML('dataset')
+                                end
+                            end
+
+                            # metadata information - metadata custodian - required
+                            custodians = false
+                            if hMetaInfo
+                                if hMetaInfo[:metadataCustodians]
+                                    aCustodians = hMetaInfo[:metadataCustodians]
+                                    unless aCustodians.empty?
+                                        custodians = true
+                                        aCustodians.each do |hCustodian|
+                                            @xml.tag!('gmd:contact') do
+                                                rPartyClass.writeXML(hCustodian)
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                            if !custodians
+                                @xml.tag!('gmd:contact', {'gco:nilReason' => 'missing'})
+                            end
+
+                            # metadata information - date stamp - required - default to now()
+                            mDate = AdiwgDateTimeFun.stringDateFromDateTime(DateTime.now, 'YMD')
+                            if hMetaInfo
+                                if hMetaInfo[:metadataCreateDate]
+                                    hDate = hMetaInfo[:metadataCreateDate]
+                                    unless hDate.empty?
+                                        mDateTime = hDate[:dateTime]
+                                        mDateRes = hDate[:dateResolution]
+                                        unless mDateTime.nil?
+                                            mDate = AdiwgDateTimeFun.stringDateFromDateTime(mDateTime, mDateRes)
+                                        end
+                                    end
+                                end
+                            end
+                            @xml.tag!('gmd:dateStamp') do
+                                @xml.tag!('gco:Date', mDate)
+                            end
+
+                            # metadata information - metadata standard name - default
+                            @xml.tag!('gmd:metadataStandardName') do
+                                @xml.tag!('gco:CharacterString', 'ISO 19115-2')
+                            end
+
+                            # metadata information - metadata standard version - default
+                            @xml.tag!('gmd:metadataStandardVersion') do
+                                @xml.tag!('gco:CharacterString', 'ISO 19115-2:2009(E)')
+                            end
+
+                            # metadata information - dataset URI
+                            # for the dataset URI adiwgJson follows the ISO 19115-1 convention which is
+                            # ... to include links to the resource in the onlineResource section of the
+                            # ... resource citation.  Because citation onlineResource(s) are not supported
+                            # ... in -2, the URI from the first onlineResource in the adiwgJson is used
+                            # ... for the datasetURI.
+                            # ... metadata: {resourceInfo: {citation: {citOlResources[0]: {olResURI:}}}}
+                            s = nil
+                            if hResInfo[:citation]
+                                if hResInfo[:citation][:citOlResources][0]
+                                    if hResInfo[:citation][:citOlResources][0][:olResURI]
+                                        s = hResInfo[:citation][:citOlResources][0][:olResURI]
+                                    end
+                                end
+                            end
+                            if !s.nil?
+                                @xml.tag!('gmd:dataSetURI') do
+                                    @xml.tag!('gco:CharacterString', s)
+                                end
+                            elsif $showAllTags
+                                @xml.tag!('gmd:dataSetURI')
+                            end
+
+                            # metadata information - reference system
+                            hRefSystems = hResInfo[:spatialReferenceSystem]
+                            if !hRefSystems.empty?
+
+                                # named reference systems
+                                aRefNames = hRefSystems[:sRNames]
+                                aRefNames.each do |refName|
+                                    @xml.tag!('gmd:referenceSystemInfo') do
+                                        refSysClass.writeXML(refName, 'name')
+                                    end
+                                end
+
+                                # epsg reference systems
+                                aRefNames = hRefSystems[:sREPSGs]
+                                aRefNames.each do |refName|
+                                    @xml.tag!('gmd:referenceSystemInfo') do
+                                        refSysClass.writeXML(refName, 'epsg')
+                                    end
+                                end
+
+                                # wkt reference systems
+                                aRefNames = hRefSystems[:sRWKTs]
+                                aRefNames.each do |refName|
+                                    @xml.tag!('gmd:referenceSystemInfo') do
+                                        refSysClass.writeXML(refName, 'wkt')
+                                    end
+                                end
+
+                            elsif $showAllTags
+                                @xml.tag!('gmd:referenceSystemInfo')
+                            end
+
+                            # metadata information - metadata extension info
+                            extensions = false
+                            if hMetaInfo
+                                if hMetaInfo[:extensions]
+                                    aExtensions = hMetaInfo[:extensions]
+                                    if !aExtensions.empty?
+                                        extensions = true
+                                        aExtensions.each do |hExtension|
+                                            @xml.tag!('gmd:metadataExtensionInfo') do
+                                                mdExtClass.writeXML(hExtension)
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                            if !extensions && $showAllTags
+                                @xml.tag!('gmd:metadataExtensionInfo')
+                            end
+
+                            # metadata information - identification info - required
+                            if hResInfo.empty?
+                                @xml.tag!('gmd:identificationInfo', {'gco:nilReason' => 'missing'})
+                            else
+                                @xml.tag!('gmd:identificationInfo') do
+                                    dataIdClass.writeXML(hResInfo, aAssocRes)
+                                end
+                            end
+
+                            # metadata information - content info
+                            # ... information about data and link to 19110
+                            # ... on hold until 19115-1 release
+
+                            # metadata information - distribution info []
+                            aDistInfo = intMetadata[:distributorInfo]
+                            if !aDistInfo.empty?
+                                @xml.tag!('gmd:distributionInfo') do
+                                    distClass.writeXML(aDistInfo)
+                                end
+                            elsif $showAllTags
+                                @xml.tag!('gmd:distributionInfo')
+                            end
+
+                            # metadata information - data quality info
+                            aDQInfo = hResInfo[:dataQualityInfo]
+                            if !aDQInfo.empty?
+                                aDQInfo.each do |hDQInfo|
+                                    @xml.tag!('gmd:dataQualityInfo') do
+                                        dqClass.writeXML(hDQInfo)
+                                    end
+                                end
+                            elsif $showAllTags
+                                @xml.tag!('gmd:dataQualityInfo')
+                            end
+
+                            # metadata information - metadata maintenance
+                            maintInfo = false
+                            if hMetaInfo
+                                if hMetaInfo[:maintInfo]
+                                    hMetaMaint = hMetaInfo[:maintInfo]
+                                    if !hMetaMaint.empty?
+                                        maintInfo = true
+                                        @xml.tag!('gmd:metadataMaintenance') do
+                                            metaMaintClass.writeXML(hMetaMaint)
+                                        end
+                                    end
+                                end
+                            end
+                            if !maintInfo && $showAllTags
+                                @xml.tag!('gmd:metadataMaintenance')
+                            end
+
+                        end
+
+                        return metadata
+                    end
+
+                end
+
+            end
+        end
+    end
+end