adiwg-mdjson_schemas 1.1.3 → 2.0.0.pre.alpha

data/examples/transferOption.json

@@ -0,0 +1,36 @@
+[{
+  "unitsOfDistribution": "unitsOfDistribution",
+  "transferSize": 9.9,
+  "onlineOption": [{
+      "uri": "http://adiwg.org"
+    },
+    {
+      "uri": "http://adiwg.org/"
+    }
+  ],
+  "offlineOption": [{
+      "mediumSpecification": {
+        "title": "title0"
+      }
+    },
+    {
+      "mediumSpecification": {
+        "title": "title1"
+      }
+    }
+  ],
+  "transferFrequency": {
+    "months": 9
+  },
+  "distributionFormat": [{
+      "formatSpecification": {
+        "title": "title0"
+      }
+    },
+    {
+      "formatSpecification": {
+        "title": "title1"
+      }
+    }
+  ]
+}]

data/examples/usage.json

@@ -1,35 +1,50 @@
-[
-  {
-    "specificUsage": "specificUsage",
-    "userDeterminedLimitation": "userDeterminedLimitation",
-    "userContactInfo": [
-      {
-        "contactId": "contactId1",
-        "role": "role1"
-      }, {
-        "contactId": "contactId2",
-        "role": "role2"
+[{
+  "specificUsage": "specificUsage",
+  "temporalExtent": [{
+      "type": "instant",
+      "timeInstant": {
+        "dateTime": "2016-10-24T11:10:15.2-10:00"
       }
-    ]
-  }, {
-    "specificUsage": "Developed for land use planning.",
-    "userDeterminedLimitation": "Not suitable for use for navigation.",
-    "userContactInfo": [
-      {
-        "contactId": "3",
-        "role": "publisher"
-      }, {
-        "contactId": "3",
-        "role": "author"
+    },
+    {
+      "type": "period",
+      "timePeriod": {
+        "startDateTime": "2016-10-24T11:10:15.2-10:00"
       }
-    ]
-  }, {
-    "specificUsage": "Bathymetry datasets developed for modeling physical oceanographic conditions in the Barrow Straight.",
-    "userContactInfo": [
-      {
-        "contactId": "1",
-        "role": "custodian"
-      }
-    ]
-  }
-]
+    }
+  ],
+  "userDeterminedLimitation": "userDeterminedLimitation",
+  "limitationResponse": [
+    "limitationResponse0",
+    "limitationResponse1"
+  ],
+  "documentedIssue": {
+    "title": "title0"
+  },
+  "additionalDocumentation": [{
+      "title": "title1"
+    },
+    {
+      "title": "title2"
+    }
+  ],
+  "userContactInfo": [{
+      "role": "role0",
+      "timePeriod": [{
+        "startDateTime": "2016-10-14"
+      }],
+      "party": [{
+        "contactId": "individualId0"
+      }]
+    },
+    {
+      "role": "role1",
+      "roleExtent": {
+        "description": "description1"
+      },
+      "party": [{
+        "contactId": "individualId1"
+      }]
+    }
+  ]
+}]

data/examples/vectorObject.json

@@ -0,0 +1,4 @@
+[{
+  "objectType": "objectType",
+  "objectCount": 9
+}]

data/examples/vectorRepresentation.json

@@ -0,0 +1,10 @@
+[{
+  "topologyLevel": "topologyLevel",
+  "vectorObject": [{
+    "objectType": "objectType",
+    "objectCount": 9
+  }, {
+    "objectType": "objectType",
+    "objectCount": 9
+  }]
+}]

data/examples/verticalExtent.json

@@ -1,18 +1,11 @@
-[
-  {
-    "minimumValue": 1,
-    "maximumValue": 1,
-    "verticalCRSTitle": "verticalCRSTitle",
-    "verticalCRSUri": "http://thisisanexample.com"
-  }, {
-    "minimumValue": 125,
-    "maximumValue": 222,
-    "verticalCRSTitle": "NAVD88 height (ftUS)",
-    "verticalCRSUri": "http://www.epsg-registry.org/export.htm?gml=urn:ogc:def:axis-name:EPSG::9904"
-  }, {
-    "minimumValue": 1500,
-    "maximumValue": 0,
-    "verticalCRSTitle": "NAVD88 depth",
-    "verticalCRSUri": "http://www.epsg-registry.org/export.htm?gml=urn:ogc:def:crs:EPSG::6357"
+[{
+  "description": "description",
+  "minValue": 9.9,
+  "maxValue": 9.9,
+  "crsId": {
+    "type": "referenceSystemType",
+    "systemIdentifier": {
+      "identifier": "identifier"
+    }
   }
-]
+}]

data/examples/voucher.json

@@ -0,0 +1,12 @@
+ [{
+   "specimen": "specimen",
+   "repository": {
+     "role": "role",
+     "timePeriod": [{
+       "startDateTime": "2016-10-14"
+     }],
+     "party": [{
+       "contactId": "individualId0"
+     }]
+   }
+ }]

data/lib/adiwg/mdjson_schemas/utils.rb

@@ -1,20 +1,50 @@
+require 'json'
+require 'json-schema'
+
 module ADIWG
-    module MdjsonSchemas
-        module Utils
-            # Return the path to main schema.json file.
-            def self.schema_path
-                File.join(File.dirname(File.expand_path(__FILE__)), '../../../schema/schema.json')
-            end
+  module MdjsonSchemas
+    # Utility methods for accessing and loading schemas
+    #
+    module Utils
+      # load json files
+      #
+      # @param [String] filename The path and file name to load
+      def self.load_json(filename)
+        JSON.load File.new(filename)
+      end
+
+      # Return the path to main schema.json file.
+      #
+      # @return [String] The path to the schema.json file
+      def self.schema_path
+        File.join(File.dirname(File.expand_path(__FILE__)), '../../../schema/schema.json')
+      end
+
+      # Return the path to schema directory.
+      #
+      # @return [String] The path to schema directory
+      def self.schema_dir
+        File.join(File.dirname(File.expand_path(__FILE__)), '../../../schema/')
+      end
+
+      # Return the path to examples directory.
+      #
+      # @return [String] The path to examples directory
+      def self.examples_dir
+        File.join(File.dirname(File.expand_path(__FILE__)), '../../../examples/')
+      end
 
-            # Return the path to schema directory.
-            def self.schema_dir
-                File.join(File.dirname(File.expand_path(__FILE__)), '../../../schema/')
-            end
+      # Pre-load all of the json-schemas for mdJSON validation
+      #
+      # @return [nil]
+      def self.load_schemas
+        Dir.glob(schema_dir + '*.json') do |schema|
+          name = File.basename(schema)
+          jschema = JSON::Schema.new(Utils.load_json(schema), Addressable::URI.parse(name))
 
-            # Return the path to examples directory.
-            def self.examples_dir
-                File.join(File.dirname(File.expand_path(__FILE__)), '../../../examples/')
-            end
+          JSON::Validator.add_schema(jschema)
         end
+      end
     end
-end
+  end
+end

data/lib/adiwg/mdjson_schemas/validator.rb

@@ -1,14 +1,13 @@
-=begin
-* Description: Patches json-schema gem to work on windows
-* Author: Josh Bradley
-* Date: 2014-09-17
-* License: Public Domain
-=end
+
 
 module JSON
 
   class Validator
 
+    # Patches json-schema(<2.5) gem to work on Windows
+    #
+    # @author Josh Bradley
+
     def load_ref_schema(parent_schema,ref)
       uri = URI.parse(ref)
       if uri.relative?
@@ -39,4 +38,4 @@ module JSON
     end
 
   end
-end
+end

data/lib/adiwg/mdjson_schemas/version.rb

@@ -1,6 +1,6 @@
 module ADIWG
     module MdjsonSchemas
         # Current schema version number
-        VERSION = "1.1.3"
+        VERSION = "2.0.0-alpha"
     end
 end

data/lib/adiwg/mdjson_schemas.rb

@@ -1,7 +1,9 @@
-require "adiwg/mdjson_schemas/version"
+require 'adiwg/mdjson_schemas/version'
 
 module ADIWG
+    # Module for accessing ADIwg mdJSON schemas
+    #
     module MdjsonSchemas
         autoload :Utils, 'adiwg/mdjson_schemas/utils'
-  end
+    end
 end

data/schema/additionalDocumentation.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "additionalDocumentation.json#",
+  "type": "object",
+  "title": "additionalDocumentation",
+  "description": "Other documents related to, but not defining, the resource such as factsheets, data catalog pages, award documents, proposals, and informational websites.",
+  "translation": {
+    "ISO 19115-2": ["MD_DataIdentification > aggregationInfo > MD_AggregateInformation > aggregateDataSetName > CI_Citation"],
+    "FGDC CSDGM": ["idinfo > crossref "]
+  },
+  "required": ["citation"],
+  "properties": {
+    "resourceType": {
+      "type": "string",
+      "description": "Identifies the type of resource, such as: userGuide, website, report, etc.",
+      "translation": {
+        "ISO 19115-2": ["[MD_ScopeCode]"]
+      }
+    },
+    "citation": {
+      "type": "array",
+      "description": "Citation for the additional resource.",
+      "translation": {},
+      "items": {
+        "$ref": "citation.json#"
+      }
+    }
+  }
+}

data/schema/associatedResource.json

@@ -0,0 +1,49 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "id" : "associatedResource.json#",
+    "type": "object",
+    "title": "associatedResource",
+    "description": "Other resources which are directly related to the subject resource such as parent, child, or sibling datasets or projects.",
+    "example": "",
+    "translation": {
+      "ISO 19115-2": ["MD_DataIdentification > aggregationInfo > MD_AggregateInformation"],
+      "FGDC CSDGM": ["idinfo > crossref"]
+    },
+    "required": ["associationType", "resourceType", "resourceCitation"],
+    "additionalProperties": true,
+    "properties": {
+      "associationType": {
+        "type": "string",
+        "description": "Identifies how the associated resource is related to the subject resource such as 'is a component of', 'larger work citation', 'cross reference', etc.",
+        "translation": {
+          "ISO 19115-2": ["MD_AggregateInformation > associationType [DS_AssociationTypeCode]"]
+        }
+      },
+      "initiativeType": {
+        "type": "string",
+        "description": "Identifies type of initiative under which the resource was produced - the activity that resulted in the resource.",
+        "translation": {
+          "ISO 19115-2": ["MD_AggregateInformation > initiativeType > [DS_InitiativeTypeCode]"]
+        }
+      },
+      "resourceType": {
+        "type": "string",
+        "description": "Identifies the type of resource, such as: a dataset, study, publication, etc.",
+        "translation": {
+          "ISO 19115-2": ["[MD_ScopeCode]"]
+        }
+      },
+      "resourceCitation": {
+        "description": "Citation for the associated resource.",
+        "translation": {
+          "ISO 19115-2": ["MD_AggregateInformation > aggregateDataSetName > CI_Citation"],
+          "FGDC CSDGM": ["idinfo > crossref > citeinfo"]
+        },
+        "$ref": "./citation.json#"
+      },
+      "metadataCitation": {
+        "description": "Citation for the associated resource metadata.",
+        "$ref": "./citation.json#"
+      }
+    }
+}

data/schema/attribute.json

@@ -0,0 +1,157 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "attribute.json#",
+  "type": "object",
+  "title": "",
+  "description": "",
+  "required": [],
+  "dependencies": {
+    "minValue": ["units"],
+    "maxValue": ["units"],
+    "boundMin": ["boundUnits"],
+    "boundMax": ["boundUnits"],
+    "sequenceIdentifier": ["sequenceIdentifierType"]
+  },
+  "additionalProperties": true,
+  "properties": {
+    "sequenceIdentifier": {
+      "type": "string",
+      "description": "Unique name or number that identifies attributes included in the coverage.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription >  gmi:rangeElementDescription > gmi:MI_RangeElementDescription > gmi:name", "MI_CoverageDescription >  gmd:dimension > gmd:MD:Band > gmd:sequenceIdentifier > gco:MemberName > gco:aName"]
+      }
+    },
+    "sequenceIdentifierType": {
+      "type": "string",
+      "description": "The type of unique name or number that identifies attributes.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD:Band > gmd:sequenceIdentifier > gco:MemberName > gco:attributeType > gco:TypeName > gco:aName"]
+      }
+    },
+    "attributeDescription": {
+      "type": "string",
+      "description": "Description of the attribute.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription >  gmi:rangeElementDescription > gmi:MI_RangeElementDescription > gmi:definition", "MI_CoverageDescription >  gmd:dimension > gmd:MD_Band > gmd:descriptor ]"]
+      }
+    },
+    "attributeIdentifier": {
+      "type": "array",
+      "description": "Identifiers for each attribute included in the resource. NOTE: These identifiers can be used to provide names for the attribute from a standard set of names.",
+      "example": "",
+      "translation": {},
+      "items": {
+        "$ref": "./identifier.json#",
+        "example": ""
+      }
+    },
+    "minValue": {
+      "type": "number",
+      "description": "The minimum value of data values in the domain of the attribute.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:minValue > gco:Real"]
+      }
+    },
+    "maxValue": {
+      "type": "number",
+      "description": "The maximum value of data values in the domain of the attribute",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:maxValue > gco:Real"]
+      }
+    },
+    "units": {
+      "type": "string",
+      "description": "The units of data in which the attribute is expressed.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:units > gml:unitDefinition > gml:identifier"]
+      }
+    },
+    "scaleFactor": {
+      "type": "number",
+      "description": "The scale factor which has been applied to the attribute.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:scaleFactor > gco:Real"]
+      }
+    },
+    "offset": {
+      "type": "number",
+      "description": "The physical value corresponding to an attribute value of zero.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:offset > gco:Real"]
+      }
+    },
+    "meanValue": {
+      "type": "number",
+      "description": "The mean value of data values in the attribute.",
+      "translation": {}
+    },
+    "numberOfValues": {
+      "type": "integer",
+      "description": "Tthe number of values used in a thematic-Classification resource.",
+      "translation": {}
+    },
+    "standardDeviation": {
+      "type": "number",
+      "description": "The standard deviation of data values in the attribute.",
+      "translation": {}
+    },
+    "bitsPerValue": {
+      "type": "integer",
+      "description": "The maximum number of significant bits in the uncompressed representation for the value in each pixel.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:bitsPerValue > gco:Integer"]
+      }
+    },
+    "boundMin": {
+      "type": "number",
+      "description": "The shortest wavelength that the sensor is capable of collecting within a designated band."
+    },
+    "boundMax": {
+      "type": "number",
+      "description": "The longest wavelength that the sensor is capable of collecting within a designated band."
+    },
+    "boundUnits": {
+      "type": "string",
+      "description": "The unit in which sensor wavelengths are expressed."
+    },
+    "peakResponse": {
+      "type": "number",
+      "description": "The wavelength at which the sensor response is highest.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:peakResponse > gco:Real"]
+      }
+    },
+    "toneGradations": {
+      "type": "integer",
+      "description": "The number of discrete numerical values in the grid data.",
+      "translation": {
+        "ISO 19115-2": ["MI_CoverageDescription > gmd:dimension > gmd:MD_Band > gmd:toneGradition > gco:Integer"]
+      }
+    },
+    "bandBoundaryDefinition": {
+      "type": "string",
+      "description": "Designation of criterion for defining maximum and minimum wavelengths for a spectral band.",
+      "translation": {}
+    },
+    "nominalSpatialResolution": {
+      "type": "number",
+      "description": "The smallest distance between which separate points can be distinguished, as specified in instrument design.",
+      "translation": {}
+    },
+    "transferFunctionType": {
+      "type": "string",
+      "description": "Type of transfer function to be used when scaling a physical value for a given element.",
+      "translation": {}
+    },
+    "transmittedPolarization": {
+      "type": "string",
+      "description": "Polarization of the radiation transmitted.",
+      "translation": {}
+    },
+    "detectedPolarization": {
+      "type": "string",
+      "description": "Polarization of the radiation detected.",
+      "translation": {}
+    }
+  }
+}

data/schema/attributeGroup.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "attributeGroup.json#",
+  "type": "object",
+  "description": "Information about groups of attributes describing a coverage.",
+  "required": ["attributeContentType"],
+  "additionalProperties": true,
+  "properties": {
+    "attributeContentType": {
+      "type": "array",
+      "description": "Type of information represented by the values",
+      "translation": {
+        "ISO 19115-2": ["MI_ImageDescription | MI_CoverageDescription > contentType"]
+      },
+      "items": {
+        "type": "string"
+      }
+    },
+    "attribute": {
+      "type": "array",
+      "description": "",
+      "example": "",
+      "translation": {},
+      "items": {
+        "$ref": "./attribute.json#"
+      }
+    }
+  }
+}

data/schema/{schema/geojson/bbox.json → bbox.json}

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "id": "bbox.json#",
-  "description": "To include information on the coordinate range for geometries, features, or feature collections, a GeoJSON object may have a member named \"bbox\". The value of the bbox member must be a 2*n array where n is the number of dimensions represented in the contained geometries, with the lowest values for all axes followed by the highest values. The axes order of a bbox follows the axes order of geometries. In addition, the coordinate reference system for the bbox is assumed to match the coordinate reference system of the GeoJSON object of which it is a member.",
+  "description": "A GeoJSON object MAY have a member named 'bbox' to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2 * n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. The values of a 'bbox' array are[west, south, east, north].",
   "translation": {
     "ISO 19115-2": ["EX_Extent > geographicElement > EX_GeographicBoundingBox, EX_GeographicBoundingBox > westBoundLongitude > Decimal {west}, EX_GeographicBoundingBox > eastBoundLongitude > Decimal {east}, EX_GeographicBoundingBox > southBoundLatitude > Decimal {south}, EX_GeographicBoundingBox > northBoundLatitude > Decimal {north}"],
     "FGDC CSDGM": ["[idinfo > spdom > bounding > westbc], [idinfo > spdom > bounding > eastbc], [idinfo > spdom > bounding > northbc], [idinfo > spdom > bounding > southbc]"]
@@ -11,4 +11,4 @@
   "items": {
     "type": "number"
   }
-}
+}