adiwg-mdtranslator 0.8.0

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_metadata.rb

@@ -0,0 +1,76 @@
+# unpack metadata
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-08-22 original script
+#   Stan Smith 2013-09-23 added distributor info section
+#   Stan Smith 2013-11-26 added metadata maintenance section
+#   Stan Smith 2013-11-26 added hierarchy section
+#   Stan Smith 2013-11-26 added data quality section
+#   Stan Smith 2013-12-27 added parent identifier
+#   Stan Smith 2014-04-24 reorganized for json schema 0.3.0
+#   Stan Smith 2014-05-02 added associated resources
+#   Stan Smith 2014-05-02 added additional documentation
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_metadataInfo', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_resourceInfo', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_distributionInfo', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_associatedResource', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_citation', $response[:readerVersionUsed])
+
+module Adiwg_Metadata
+
+	def self.unpack(hMetadata)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intMetadata = intMetadataClass.newMetadata
+
+		# metadata - metadataInfo
+		# metadataInfo needs access to resourceInfo to check taxonomy
+		if hMetadata.has_key?('metadataInfo')
+			intMetadata[:metadataInfo] = Adiwg_MetadataInfo.unpack(hMetadata)
+		end
+
+		# metadata - resource identification info
+		if hMetadata.has_key?('resourceInfo')
+			hResourceInfo = hMetadata['resourceInfo']
+			intMetadata[:resourceInfo] = Adiwg_ResourceInfo.unpack(hResourceInfo)
+		end
+
+		# metadata - distribution info
+		if hMetadata.has_key?('distributionInfo')
+			aDistributors = hMetadata['distributionInfo']
+			unless aDistributors.empty?
+				aDistributors.each do |hDistributor|
+					intMetadata[:distributorInfo] << Adiwg_DistributionInfo.unpack(hDistributor)
+				end
+			end
+		end
+
+		# metadata - associated resources
+		if hMetadata.has_key?('associatedResource')
+			aAssocRes = hMetadata['associatedResource']
+			unless aAssocRes.empty?
+				aAssocRes.each do |hAssocRes|
+					intMetadata[:associatedResources] << Adiwg_AssociatedResource.unpack(hAssocRes)
+				end
+			end
+		end
+
+		# metadata - additional documents
+		if hMetadata.has_key?('additionalDocumentation')
+			aCitation = hMetadata['additionalDocumentation']
+			unless aCitation.empty?
+				aCitation.each do |hCitation|
+					intMetadata[:additionalDocuments] << Adiwg_Citation.unpack(hCitation)
+				end
+			end
+		end
+
+		return intMetadata
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_metadataExtension.rb

@@ -0,0 +1,40 @@
+# unpack metadata extension information
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-22 original script
+#   Stan Smith 2014-05-15 modified for JSON schema 0.4.0
+
+module Adiwg_MetadataExtension
+
+	def self.addExtensionISObio()
+
+		intMetadataClass = InternalMetadata.new
+		intMetaExt = intMetadataClass.newMetadataExtension
+		intContactRole = intMetadataClass.newRespParty
+
+		# extension online information
+		intMetaExt[:onLineResource] = {}
+
+		# extension entity information
+		intMetaExt[:extName] = 'Taxonomy System'
+		intMetaExt[:extShortName] = 'TaxonSys'
+		intMetaExt[:extDefinition] = 'Documentation of taxonomic sources, procedures, and treatments'
+		intMetaExt[:obligation] = 'optional'
+		intMetaExt[:dataType] = 'class'
+		intMetaExt[:maxOccurrence] = '1'
+		intMetaExt[:parentEntities] << 'MD_Identification'
+		intMetaExt[:rule] = 'New Metadata section as a class to MD_Identification'
+		intMetaExt[:rationales] << 'The set of data elements contained within this class element ' +
+			'represents an attempt to provide better documentation of ' +
+			'taxonomic sources, procedures, and treatments.'
+
+		# source information
+		intContactRole[:contactID] = 'ADIwgBio'
+		intContactRole[:roleName] = 'resourceProvider'
+		intMetaExt[:extSources] << intContactRole
+
+		return intMetaExt
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_metadataInfo.rb

@@ -0,0 +1,119 @@
+# unpack metadata information block
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2014-04-24 original script - moved from module_metadata
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-09-19 changed metadata identifier type resource identifier json 0.8.0
+#   Stan Smith 2014-09-19 changed parent metadata identifier type citation json 0.8.0
+
+require ADIWG::Mdtranslator.reader_module('module_responsibleParty', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_dateTime', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_resourceMaintenance', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_metadataExtension', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_resourceIdentifier', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_citation', $response[:readerVersionUsed])
+
+module Adiwg_MetadataInfo
+
+	def self.unpack(hMetadata)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intMetadataInfo = intMetadataClass.newMetadataInfo
+		hMetadataInfo = hMetadata['metadataInfo']
+
+		# metadata - metadata identifier
+		if hMetadataInfo.has_key?('metadataIdentifier')
+			hMetadataId = hMetadataInfo['metadataIdentifier']
+			unless hMetadataId.empty?
+				intMetadataInfo[:metadataId] = Adiwg_ResourceIdentifier.unpack(hMetadataId)
+			end
+		end
+
+		# metadata - parent metadata identifier
+		if hMetadataInfo.has_key?('parentMetadata')
+			hParent = hMetadataInfo['parentMetadata']
+			unless hParent.empty?
+				intMetadataInfo[:parentMetadata] = Adiwg_Citation.unpack(hParent)
+			end
+		end
+
+		# metadata - scope - from codeList
+		if hMetadataInfo.has_key?('metadataScope')
+			aMetadataScope = hMetadataInfo['metadataScope']
+			unless aMetadataScope.empty?
+				intMetadataInfo[:metadataScope] = aMetadataScope
+			end
+		end
+
+		# metadata - metadata contacts, custodians
+		if hMetadataInfo.has_key?('metadataContact')
+			aCust = hMetadataInfo['metadataContact']
+			unless aCust.empty?
+				aCust.each do |rParty|
+					intMetadataInfo[:metadataCustodians] << Adiwg_ResponsibleParty.unpack(rParty)
+				end
+			end
+		end
+
+		# metadata - creation date
+		if hMetadataInfo.has_key?('metadataCreationDate')
+			s = hMetadataInfo['metadataCreationDate']
+			if s != ''
+				hDateTime = Adiwg_DateTime.unpack(s)
+				hDateTime[:dateType] = 'publication'
+				intMetadataInfo[:metadataCreateDate] = hDateTime
+			end
+		end
+
+		# metadata - date of last metadata update
+		if hMetadataInfo.has_key?('metadataLastUpdate')
+			s = hMetadataInfo['metadataLastUpdate']
+			if s != ''
+				hDateTime = Adiwg_DateTime.unpack(s)
+				hDateTime[:dateType] = 'revision'
+				intMetadataInfo[:metadataUpdateDate] = hDateTime
+			end
+		end
+
+		# metadata - metadata URI
+		if hMetadataInfo.has_key?('metadataUri')
+			s = hMetadataInfo['metadataUri']
+			if s != ''
+				intMetadataInfo[:metadataURI] = s
+			end
+		end
+
+		# metadata - status
+		if hMetadataInfo.has_key?('metadataStatus')
+			s = hMetadataInfo['metadataStatus']
+			if s != ''
+				intMetadataInfo[:metadataStatus] = s
+			end
+		end
+
+		# metadata - metadata maintenance info
+		if hMetadataInfo.has_key?('metadataMaintenance')
+			hMetaMaint = hMetadataInfo['metadataMaintenance']
+			unless hMetaMaint.empty?
+				intMetadataInfo[:maintInfo] = Adiwg_ResourceMaintenance.unpack(hMetaMaint)
+			end
+		end
+
+		# metadata - extension info - if biological extension
+		if hMetadata.has_key?('resourceInfo')
+		resourceInfo = hMetadata['resourceInfo']
+			if resourceInfo.has_key?('taxonomy')
+				hTaxonomy = resourceInfo['taxonomy']
+				unless hTaxonomy.empty?
+					intMetadataInfo[:extensions] << Adiwg_MetadataExtension.addExtensionISObio
+				end
+			end
+		end
+
+		return intMetadataInfo
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_onlineResource.rb

@@ -0,0 +1,62 @@
+# unpack online resources
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-09-25 original script
+#   Stan Smith 2014-04-23 modified for json 0.3.0
+#   Stan Smith 2014-08-18 removed doi section for json 0.6.0
+#   Stan Smith 2014-08-21 changed url to uri for json 0.6.0
+
+module Adiwg_OnlineResource
+
+	def self.unpack(hOlResource)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intOLRes = intMetadataClass.newOnlineResource
+
+		# unpack the online resource
+		# resource - web link
+		if hOlResource.has_key?('uri')
+			s = hOlResource['uri']
+			if s != ''
+				intOLRes[:olResURI] = s
+			end
+		end
+
+		# resource - web link protocol
+		if hOlResource.has_key?('protocol')
+			s = hOlResource['protocol']
+			if s != ''
+				intOLRes[:olResProtocol] = s
+			end
+		end
+
+		# resource - web link name
+		if hOlResource.has_key?('name')
+			s = hOlResource['name']
+			if s != ''
+				intOLRes[:olResName] = s
+			end
+		end
+
+		# resource - web link description
+		if hOlResource.has_key?('description')
+			s = hOlResource['description']
+			if s != ''
+				intOLRes[:olResDesc] = s
+			end
+		end
+
+		# resource - web link function
+		if hOlResource.has_key?('function')
+			s = hOlResource['function']
+			if s != ''
+				intOLRes[:olResFunction] = s
+			end
+		end
+
+		return intOLRes
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_phone.rb

@@ -0,0 +1,59 @@
+# unpack phone
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-12-16 original script
+#   Stan Smith 2014-05-14 combine phone service types
+
+module Adiwg_Phone
+
+	def self.unpack(hPhone)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		aPhones = Array.new
+
+		# create a separate phone for each phone service type
+		# if service is missing, default service to 'voice'
+		if hPhone.has_key?('service')
+			aService = hPhone['service']
+		else
+			aService = ['voice']
+		end
+
+		if aService.empty?
+			aService = ['voice']
+		end
+
+		# if service is nil, default service to 'voice'
+		aService.each do |phService|
+			intPhone = intMetadataClass.newPhone
+
+			# phone - service
+			intPhone[:phoneServiceType] = phService
+
+			# phone - name
+			if hPhone.has_key?('phoneName')
+				s = hPhone['phoneName']
+				unless s.nil?
+					intPhone[:phoneName] = s
+				end
+			end
+
+			# phone - number
+			if hPhone.has_key?('phoneNumber')
+				s = hPhone['phoneNumber']
+				unless s.nil?
+					intPhone[:phoneNumber] = s
+				end
+			end
+
+			aPhones << intPhone
+
+		end
+
+		return aPhones
+
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_point.rb

@@ -0,0 +1,25 @@
+# unpack point
+# point is coded in GeoJSON
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-07 original script
+#   Stan Smith 2014-04-30 reorganized for json schema 0.3.0
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_coordinates', $response[:readerVersionUsed])
+
+module Adiwg_Point
+
+	def self.unpack(aCoords,geoType)
+		intMetadataClass = InternalMetadata.new
+		intPoint = intMetadataClass.newGeometry
+
+		intPoint[:geoType] = geoType
+		intPoint[:geometry] = aCoords
+		intPoint[:dimension] = Adiwg_Coordinates.getDimension(aCoords)
+
+		return intPoint
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_polygon.rb

@@ -0,0 +1,55 @@
+# unpack polygon
+# point is coded in GeoJSON
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-18 original script
+#   Stan Smith 2014-04-30 reorganized for json schema 0.3.0
+#   Stan Smith 2014-05-23 modified to handle MultiPolygon objects
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_coordinates', $response[:readerVersionUsed])
+
+module Adiwg_Polygon
+
+	def self.unpack(aCoords, geoType)
+		intMetadataClass = InternalMetadata.new
+		intGeometry = intMetadataClass.newGeometry
+		intGeometry[:geoType] = geoType
+
+		# polygon - coordinate(s)
+		if geoType == 'Polygon'
+			intGeometry[:geometry] = splitPolygons(aCoords)
+			intGeometry[:dimension] = Adiwg_Coordinates.getDimension(intGeometry[:geometry][:exteriorRing])
+		elsif geoType == 'MultiPolygon'
+			aPolySets = Array.new
+			aCoords.each do |aPolygonSet|
+				aPolySets << splitPolygons(aPolygonSet)
+			end
+			intGeometry[:geometry] = aPolySets
+		end
+
+		return intGeometry
+	end
+
+	def self.splitPolygons(aPolySet)
+		intMetadataClass = InternalMetadata.new
+		intPolygonSet = intMetadataClass.newPolygonSet
+
+		# first polygon in set is a bounding exterior ring
+		# all subsequent polygons are exclusion rings
+		i = 0
+		aPolySet.each do |aPolygon|
+			i += 1
+			if i == 1
+				intPolygonSet[:exteriorRing] = aPolygon
+			else
+				intPolygonSet[:exclusionRings] << aPolygon
+			end
+
+		end
+
+		return intPolygonSet
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_processStep.rb

@@ -0,0 +1,64 @@
+# unpack process step
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-26 original script
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+
+require ADIWG::Mdtranslator.reader_module('module_responsibleParty', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_dateTime', $response[:readerVersionUsed])
+
+module Adiwg_ProcessStep
+
+	def self.unpack(hProcStep)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intDataPStep = intMetadataClass.newDataProcessStep
+
+		# process step - step ID
+		if hProcStep.has_key?('stepId')
+			s = hProcStep['stepId']
+			if s != ''
+				intDataPStep[:stepID] = s
+			end
+		end
+
+		# process step - description
+		if hProcStep.has_key?('description')
+			s = hProcStep['description']
+			if s != ''
+				intDataPStep[:stepDescription] = s
+			end
+		end
+
+		# process step - rationale
+		if hProcStep.has_key?('rationale')
+			s = hProcStep['rationale']
+			if s != ''
+				intDataPStep[:stepRationale] = s
+			end
+		end
+
+		# process step - dateTime
+		if hProcStep.has_key?('dateTime')
+			s = hProcStep['dateTime']
+			if s != ''
+				intDataPStep[:stepDateTime] = Adiwg_DateTime.unpack(s)
+			end
+		end
+
+		# process step - step processors
+		if hProcStep.has_key?('processor')
+			aProcessors = hProcStep['processor']
+			unless aProcessors.empty?
+				aProcessors.each do |processor|
+					intDataPStep[:stepProcessors] << Adiwg_ResponsibleParty.unpack(processor)
+				end
+			end
+		end
+
+		return intDataPStep
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_resolution.rb

@@ -0,0 +1,42 @@
+# unpack resolution
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-26 original script
+
+module Adiwg_Resolution
+
+	def self.unpack(hResolution)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intResolution = intMetadataClass.newResolution
+
+		# resolution - equivalent scale
+		if hResolution.has_key?('equivalentScale')
+			s = hResolution['equivalentScale']
+			if s != ''
+				intResolution[:equivalentScale] = s
+			end
+		end
+
+		# resolution - distance
+		if hResolution.has_key?('distance')
+			s = hResolution['distance']
+			if s != ''
+				intResolution[:distance] = s
+			end
+		end
+
+		# resolution - uom
+		if hResolution.has_key?('uom')
+			s = hResolution['uom']
+			if s != ''
+				intResolution[:distanceUOM] = s
+			end
+		end
+
+		return intResolution
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_resourceFormat.rb

@@ -0,0 +1,35 @@
+# unpack resource formats
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-08-26 original script
+# 	Stan Smith 2013-11-27 modified to process single resource format rather than array
+
+module Adiwg_ResourceFormat
+
+	def self.unpack(hResFormat)
+
+	# instance classes needed in script
+	intMetadataClass = InternalMetadata.new
+		rFormat = intMetadataClass.newResourceFormat
+
+		# format - name
+		if hResFormat.has_key?('formatName')
+			s = hResFormat['formatName']
+			if s != ''
+				rFormat[:formatName] = s
+			end
+		end
+
+		# format - version
+		if hResFormat.has_key?('version')
+			s = hResFormat['version']
+			if s != ''
+				rFormat[:formatVersion] = s
+			end
+		end
+
+		return rFormat
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/modules_0.8.0/module_resourceIdentifier.rb

@@ -0,0 +1,49 @@
+# unpack resource identifier
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2014-05-28 original script
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-08-18 added type to identifier schema 0.6.0
+
+require ADIWG::Mdtranslator.reader_module('module_citation', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_responsibleParty', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_onlineResource', $response[:readerVersionUsed])
+
+module Adiwg_ResourceIdentifier
+
+	def self.unpack(hResID)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+		intResID = intMetadataClass.newResourceId
+
+		# resource identifier - identifier
+		if hResID.has_key?('identifier')
+			s = hResID['identifier']
+			if s != ''
+				intResID[:identifier] = s
+			end
+		end
+
+		# resource identifier - identifier type
+		if hResID.has_key?('type')
+			s = hResID['type']
+			if s != ''
+				intResID[:identifierType] = s
+			end
+		end
+
+		# resource identifier - authority (expressed as a citation)
+		if hResID.has_key?('authority')
+			hCitation = hResID['authority']
+			unless hCitation.empty?
+				intResID[:identifierCitation] =  Adiwg_Citation.unpack(hCitation)
+			end
+		end
+
+		return intResID
+
+	end
+
+end