adiwg-mdtranslator 0.8.0

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

@@ -0,0 +1,499 @@
+# ADIwg ISO Translator internal data structure
+
+# History:
+# 	Stan Smith 2013-08-09 original script
+# 	Stan Smith 2013-08-10 adding methods as needed
+# 	Stan Smith 2013-09-19 added keywords
+# 	Stan Smith 2013-09-20 change '' to nil for value attributes
+# 	Stan Smith 2013-09-23 added distributor
+# 	Stan Smith 2013-09-24 added distributor order process
+# 	Stan Smith 2013-09-24 added digital transfer options
+# 	Stan Smith 2013-09-24 added data transfer medium
+# 	Stan Smith 2013-10-17 added browse graphic
+# 	Stan Smith 2013-10-21 added address (separated from contact)
+# 	Stan Smith 2013-10-25 added extent
+# 	Stan Smith 2013-10-25 added bounding box
+# 	Stan Smith 2013-10-25 added point
+# 	Stan Smith 2013-10-25 added multi point
+# 	Stan Smith 2013-10-25 added line string
+# 	Stan Smith 2013-10-25 added polygon
+# 	Stan Smith 2013-10-25 added linear ring
+# 	Stan Smith 2013-10-25 added temporal extent
+# 	Stan Smith 2013-10-25 added time instant
+# 	Stan Smith 2013-10-25 added time period
+# 	Stan Smith 2013-10-25 added vertical extent
+# 	Stan Smith 2013-10-30 added constraint
+# 	Stan Smith 2013-10-31 added resource maintenance
+# 	Stan Smith 2013-11-19 added usage
+# 	Stan Smith 2013-11-19 added taxonomy
+# 	Stan Smith 2013-11-20 added data quality
+# 	Stan Smith 2013-11-20 modified citation
+# 	Stan Smith 2013-12-16 added phone book
+#   Stan Smith 2014-04-23 added protocol and doi to online resource
+#   Stan Smith 2014-04-24 added jsonVersion to newBase
+#   Stan Smith 2014-04-24 renamed newDataId to newResourceInfo
+#   Stan Smith 2014-04-24 reorganized newMetadata, newResourceInfo
+#   Stan Smith 2014-04-24 added newMetadataInfo
+#   Stan Smith 2014-04-25 modified newCitation for json schema 0.3.0
+#   Stan Smith 2014-04-25 added resource Ids to newCitation
+#   Stan Smith 2014-04-30 reorganized geometry blocks for json schema 0.3.0
+#   Stan Smith 2014-05-02 added associatedResource
+#   Stan Smith 2014-05-02 added additionalDocument
+#   Stan Smith 2014-05-28 modified resourceId & responsibleParty for schema 0.5.0
+#   Stan Smith 2014-08-15 modified citation, onlineResource, resourceId for 0.6.0
+#   Stan Smith 2014-09-03 added spatialReferenceSystems for name, EPSG, and WKT for 0.6.0
+
+class InternalMetadata
+
+	# initialize attribute values - nil
+	# initialize arrays - []
+	# initialize hashes - {}
+
+	def initialize
+	end
+
+	def newBase
+		intObj = {
+			jsonVersion: {
+				name: nil,
+				version: nil
+			},
+			contacts: [],
+			metadata: {}
+		}
+	end
+
+	def newDateTime
+		intObj = {
+			dateTime: nil,
+			dateType: nil,
+			dateResolution: nil
+		}
+	end
+
+	def newContact
+		intObj =  {
+			contactID: nil,
+			indName: nil,
+			orgName: nil,
+			position: nil,
+			phones: [],
+			address: {},
+			onlineRes: [],
+			contactInstructions: nil
+		}
+	end
+
+	def newPhone
+		intObj = {
+			phoneServiceType: nil,
+			phoneName: nil,
+			phoneNumber: nil
+		}
+	end
+
+	def newAddress
+		intObj = {
+			deliveryPoints: [],
+			city: nil,
+			adminArea: nil,
+			postalCode: nil,
+			country: nil,
+			eMailList: []
+		}
+	end
+
+	def newMetadata
+		intObj = {
+			metadataInfo: {},
+			resourceInfo: {},
+			distributorInfo: [],
+			associatedResources: [],
+			additionalDocuments: []
+		}
+	end
+
+	def newMetadataInfo
+		intObj = {
+			metadataId: {},
+			parentMetadata: {},
+			metadataScope: [],
+			metadataCustodians: [],
+			metadataCreateDate: {},
+			metadataUpdateDate: {},
+			metadataURI: nil,
+			metadataStatus: nil,
+			maintInfo: {},
+			extensions: []
+		}
+	end
+
+	def newRespParty
+		intObj = {
+			contactID: nil,
+			roleName: nil
+		}
+	end
+
+	def newOnlineResource
+		intObj = {
+			olResURI: nil,
+			olResProtocol: nil,
+		    olResName: nil,
+			olResDesc: nil,
+			olResFunction: nil
+		}
+	end
+
+	def newResourceInfo
+		intObj = {
+			citation: {},
+			abstract: nil,
+			shortAbstract: nil,
+			hasMapLocation?: nil,
+			hasDataAvailable?: nil,
+			purpose: nil,
+			credits: [],
+			status: nil,
+			pointsOfContact: [],
+			resourceMaint: [],
+			graphicOverview: [],
+			resourceFormats: [],
+			resourceLanguages: [],
+			descriptiveKeywords: [],
+			resourceUses: [],
+			useConstraints: [],
+			legalConstraints: [],
+			securityConstraints: [],
+			taxonomy: {},
+			spatialReferenceSystem: {},
+			spatialRepresentationTypes: [],
+			spatialResolutions: [],
+			topicCategories: [],
+			environmentDescription: nil,
+			extents: [],
+			dataQualityInfo: [],
+			supplementalInfo: nil
+		}
+	end
+
+	def newCitation
+		intObj = {
+			citTitle: nil,
+			citDate: [],
+			citEdition: nil,
+			citResourceIDs: [],
+			citResponsibleParty: [],
+			citResourceForms: [],
+			citOlResources: []
+		}
+	end
+
+	def newResourceId
+		intObj = {
+			identifier: nil,
+			identifierType: nil,
+			identifierCitation: {}
+		}
+	end
+
+	def newResourceFormat
+		intObj = {
+			formatName: nil,
+			formatVersion: nil
+		}
+	end
+
+	def newResourceMaint
+		intObj = {
+			maintFreq: nil,
+			maintNotes: [],
+			maintContacts: []
+		}
+	end
+
+	def newKeyword
+		intObj = {
+			keyword: [],
+			keywordType: nil,
+			keyTheCitation: {}
+		}
+	end
+
+	def newLegalCon
+		intObj = {
+			accessCons: [],
+			useCons: [],
+			otherCons: []
+		}
+	end
+
+	def newSecurityCon
+		intObj = {
+			classification: nil,
+			userNote: nil,
+			classSystem: nil,
+			handlingDesc: nil
+		}
+	end
+
+	def newDistributor
+		intObj = {
+			distContact: {},
+			distOrderProc: [],
+			distFormat: [],
+			distTransOption: []
+		}
+	end
+
+	def newDistOrder
+		intObj = {
+			fees: nil,
+			plannedDateTime: {},
+			orderInstructions: nil,
+			turnaround: nil
+		}
+	end
+
+	def newDigitalTransOption
+		intObj = {
+			online: [],
+			offline: {}
+		}
+	end
+
+	def newMedium
+		intObj = {
+			mediumName: nil,
+			mediumFormat: nil,
+			mediumNote: nil
+		}
+	end
+
+	def newBrowseGraphic
+		intObj = {
+			bGName: nil,
+			bGDescription: nil,
+			bGType: nil,
+			bGURI: nil
+		}
+	end
+
+	def newSpatialReferenceSystem
+		intObj = {
+			sRNames: [],
+			sREPSGs: [],
+			sRWKTs: []
+		}
+	end
+
+	def newExtent
+		intObj = {
+			extDesc: nil,
+			extGeoElements: [],
+			extIdElements: [],
+			extTempElements: [],
+			extVertElements: []
+		}
+	end
+
+	def newGeoElement
+		intObj = {
+			elementId: nil,
+			elementIncludeData: nil,
+			elementName: nil,
+			elementDescription: nil,
+			temporalElements: [],
+			verticalElements: [],
+			elementIdentifiers: [],
+			elementScope: nil,
+			elementAcquisition: nil,
+			elementSrs: {},
+			elementGeometry: {}
+		}
+	end
+
+	def newSRS
+		intObj = {
+			srsName: nil,
+			srsHref: nil,
+			sysType: nil
+		}
+	end
+
+	def newGeometry
+		intObj = {
+			geoType: nil,
+			geometry: {},
+			dimension: nil
+		}
+	end
+
+	def newBoundingBox
+		intObj = {
+			westLong: nil,
+			eastLong: nil,
+			southLat: nil,
+			northLat: nil
+		}
+	end
+
+	def newPolygonSet
+		intObj = {
+			exteriorRing: {},
+			exclusionRings: []
+		}
+	end
+
+	def newTemporalElement
+		intObj = {
+			date: {},
+			timeInstant: {},
+			timePeriod: {}
+		}
+	end
+
+	def newTimeInstant
+		intObj = {
+			timeID: nil,
+			description: nil,
+		    timePosition: {}
+		}
+	end
+
+	def newTimePeriod
+		intObj = {
+			timeID: nil,
+			description: nil,
+			beginTime: {},
+			endTime: {}
+		}
+	end
+
+	def newVerticalElement
+		intObj = {
+			minValue: nil,
+			maxValue: nil,
+			crsURI: nil,
+			crsTitle: nil
+		}
+	end
+
+	def newLegalConstraint
+		intObj = {
+			accessCodes: [],
+			useCodes: [],
+			otherCons: []
+		}
+	end
+
+	def newSecurityConstraint
+		intObj = {
+			classCode: nil,
+			userNote: nil,
+			classSystem: nil,
+			handlingDesc: nil
+		}
+	end
+
+	def newDataUsage
+		intObj = {
+			specificUsage: nil,
+			userLimits: nil,
+			userContacts: []
+		}
+	end
+
+	def newTaxonSystem
+		intObj = {
+			taxClassSys: [],
+			taxGeneralScope: nil,
+			taxObservers: [],
+			taxIdProcedures: nil,
+			taxVoucher: {},
+			taxClasses: []
+		}
+	end
+
+	def newTaxonVoucher
+		intObj = {
+			specimen: nil,
+			repository: {}
+		}
+	end
+
+	def newTaxonClass
+		intObj = {
+			commonName: nil,
+			taxRankName: nil,
+			taxRankValue: nil
+		}
+	end
+
+	def newResolution
+		intObj = {
+			equivalentScale: nil,
+			distance: nil,
+			distanceUOM: nil
+		}
+	end
+
+	def newDataQuality
+		intObj = {
+			dataScope: nil,
+			dataLineage: {}
+		}
+	end
+
+	def newLineage
+		intObj = {
+			statement: nil,
+			processSteps: [],
+			dataSources: []
+		}
+	end
+
+	def newDataProcessStep
+		intObj = {
+			stepID: nil,
+			stepDescription: nil,
+			stepRationale: nil,
+			stepDateTime: {},
+			stepProcessors: []
+		}
+	end
+
+	def newDataSource
+		intObj = {
+			sourceDescription: nil,
+			sourceCitation: {},
+			sourceSteps: []
+		}
+	end
+
+	def newMetadataExtension
+		intObj = {
+			onLineResource: {},
+			extName: nil,
+			extShortName: nil,
+			extDefinition: nil,
+			obligation: nil,
+			dataType: nil,
+			maxOccurrence: nil,
+			parentEntities: [],
+			rule: nil,
+			rationales: [],
+			extSources: []
+		}
+	end
+
+	def newAssociatedResource
+		intObj = {
+			associationType: nil,
+			resourceType: nil,
+			resourceCitation: {},
+			metadataCitation: {}
+		}
+	end
+
+end

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

@@ -0,0 +1,98 @@
+# date, dateTime methods
+# for ADIwg readers and writers
+
+# History:
+# 	Stan Smith 2013-09-26 original script
+# 	Stan Smith 2013-12-06 added support for fractional seconds
+
+require 'date'
+
+module AdiwgDateTimeFun
+
+	def self.dateTimeFromString(inDateTime)
+		hFormats = {'YMDhmsLZ'=> '%Y-%m-%dT%H:%M:%S.%L%z',
+					'YMDhmsL'=> '%Y-%m-%dT%H:%M:%S.%L',
+					'YMDhmsZ'=> '%Y-%m-%dT%H:%M:%S%z',
+					'YMDhms'=> '%Y-%m-%dT%H:%M:%S',
+					'YMDhmZ'=> '%Y-%m-%dT%H:%M%z',
+					'YMDhm'=> '%Y-%m-%dT%H:%M',
+					'YMDhZ'=> '%Y-%m-%dT%H%z',
+					'YMDh'=> '%Y-%m-%dT%H',
+					'YMD'=> '%Y-%m-%d',
+					'YM'=> '%Y-%m',
+					'Y'=> '%Y'}
+		hFormats.each do |dateResolution, format|
+			myDateTime = DateTime.strptime(inDateTime,format) rescue false
+			return myDateTime, dateResolution if myDateTime
+		end
+
+		return nil, 'ERROR'
+	end
+
+	def self.stringDateFromDateTime(myDateTime,dateResolution)
+		s = case dateResolution
+				when 'YMDhmsLZ','YMDhmsL','YMDhmsZ', 'YMDhms',
+					'YMDhmZ', 'YMDhm', 'YMDhZ', 'YMDh','YMD'
+					myDateTime.strftime('%Y-%m-%d')
+				when 'YM'
+					myDateTime.strftime('%Y-%m')
+				when 'Y'
+					myDateTime.strftime('%Y')
+				else
+					'ERROR'
+			end
+
+		return s
+	end
+
+	def self.stringDateTimeFromDateTime(myDateTime,dateResolution)
+		s = case dateResolution
+				when 'YMDhmsLZ'
+					myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L%:z')
+				when 'YMDhmsL'
+					myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L')
+				when 'YMDhmsZ'
+					myDateTime.strftime('%Y-%m-%dT%H:%M:%S%:z')
+				when 'YMDhms', 'YMD', 'YM', 'Y'
+					myDateTime.strftime('%Y-%m-%dT%H:%M:%S')
+				when 'YMDhmZ'
+					myDateTime.strftime('%Y-%m-%dT%H:%M%:z')
+				when 'YMDhm'
+					myDateTime.strftime('%Y-%m-%dT%H:%M')
+				when 'YMDhZ'
+					myDateTime.strftime('%Y-%m-%dT%H%:z')
+				when 'YMDh'
+					myDateTime.strftime('%Y-%m-%dT%H')
+				else
+					'ERROR'
+			end
+
+		return s
+	end
+
+	def self.stringTimeFromDateTime(myDateTime,dateResolution)
+		s = case dateResolution
+				when 'YMDhmsLZ'
+					myDateTime.strftime('%H:%M:%S.%L%:z')
+				when 'YMDhmsL'
+					myDateTime.strftime('%H:%M:%S.%L')
+				when 'YMDhmsZ'
+					myDateTime.strftime('%H:%M:%S%:z')
+				when 'YMDhms'
+					myDateTime.strftime('%H:%M:%S')
+				when 'YMDhmZ'
+					myDateTime.strftime('%H:%M%:z')
+				when 'YMDhm'
+					myDateTime.strftime('%H:%M')
+				when 'YMDhZ'
+					myDateTime.strftime('%H%:z')
+				when 'YMDh'
+					myDateTime.strftime('%H')
+				else
+					'ERROR'
+			end
+
+		return s
+	end
+
+end

data/lib/adiwg/mdtranslator/readers/adiwgJson/adiwgJson_reader.rb

@@ -0,0 +1,80 @@
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-08-09 original script
+# 	Stan Smith 2013-08-19 split out contacts to module_contacts
+# 	Stan Smith 2013-08-23 split out metadata to module_metadata
+#	Stan Smith 2014-04-23 add json schema version to internal object
+#   Stan Smith 2014-06-05 capture an test json version
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-07-08 moved json schema version testing to 'adiwg_1_get_version'
+#   Stan Smith 2014-08-18 add json name/version to internal object
+
+require 'json'
+require ADIWG::Mdtranslator.reader_module('module_contacts', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_metadata', $response[:readerVersionUsed])
+
+class AdiwgJsonReader
+
+	def initialize
+	end
+
+	def unpack(jsonObj)
+
+		# instance classes needed in script
+		intMetadataClass = InternalMetadata.new
+
+		# create new internal metadata container for the reader
+		intBase = intMetadataClass.newBase
+
+		# convert the received JSON to a Ruby hash
+		hashObj = JSON.parse(jsonObj)
+
+		# get json schema name and version
+		if hashObj.has_key?('version')
+			hVersion = hashObj['version']
+		    unless hVersion.empty?
+				if hVersion.has_key?('name')
+					s = hVersion['name']
+					if !s.nil?
+						intBase[:jsonVersion][:name] = s
+					end
+				end
+				if hVersion.has_key?('version')
+					s = hVersion['version']
+					if !s.nil?
+						intBase[:jsonVersion][:version] = s
+					end
+				end
+			end
+		end
+
+		# contact
+		# load the array of contacts from the json object
+		# ... the contacts array uses a local id to reference the
+		# ... contact in the array from elsewhere in the json metadata
+		if hashObj.has_key?('contact')
+			aContacts = hashObj['contact']
+			aContacts.each do |hContact|
+				unless hContact.empty?
+					intBase[:contacts] << Adiwg_Contact.unpack(hContact)
+				end
+			end
+		end
+
+		# add default contacts
+		intBase[:contacts].concat(Adiwg_Contact.setDefaultContacts)
+
+		# metadata
+		# load metadata from the hash object
+		if hashObj.has_key?('metadata')
+			hMetadata = hashObj['metadata']
+			intBase[:metadata] = Adiwg_Metadata.unpack(hMetadata)
+		end
+
+		# return ADIwg internal container
+		return intBase
+
+	end
+
+end