coverage-schema.json

{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Coverage object",
   "description": "Component of OGC Coverage Implementation Schema 1.1. Last updated: 2016-may-18. Copyright (c) 2016 Open Geospatial Consortium, Inc. All Rights Reserved. To obtain additional rights of use, visit http://www.opengeospatial.org/legal/.",
   "type": "object",
   "oneOf" : [{
      "required": [ "type", "domainSet", "rangeSet", "rangeType"],
      "properties": {
         "id": { "type": "string"},
         "type": { "enum": [ "CoverageByDomainAndRange" ] },
         "envelope": { "$ref": "#/definitions/envelope" },
         "domainSet": { "$ref": "#/definitions/domainSet" },
         "rangeSet": { "$ref": "#/definitions/rangeSet" },
         "rangeType": { "$ref": "#/definitions/rangeType" },
         "metadata": { "$ref": "#/definitions/metadata" }
      }
   },{
      "required": [ "type", "partitionSet", "rangeType"],
      "properties": {
         "id": { "type": "string"},
         "type": { "enum": [ "CoverageByPartitioning" ] },
         "envelope": { "$ref": "#/definitions/envelope" },
         "partitionSet": { "$ref": "#/definitions/partitionSet" },
         "rangeType": { "$ref": "#/definitions/rangeType" },
         "metadata": { "$ref": "#/definitions/metadata" }
      }
   }],
   "definitions": {
      "envelope": {
         "title": "envelope",
         "description": "The envelope around a coverage is defined by the lower and upper bound of each axis, respectively. The purpose of the axisLabels attribute, which lists the axis labels of all axisExtent elements in proper sequence, is to enforce axis sequence also in XML systems which do not preserve document order.",
         "type": "object",
         "required": [ "type", "srsName", "axisLabels", "axis"],
         "properties": {
            "type": { "enum": [ "EnvelopeByAxis"] },
            "id":  { "type": "string" },
            "srsName": { "type": "string", "format": "uri"},
            "axisLabels":
            {
               "type": "array",
               "items": { "type": "string" }
            },
            "axis": {
               "type": "array",
               "items": {
                  "type": "object",
                  "required": [ "type", "lowerBound", "upperBound", "uomLabel"],
                  "additionalProperties": false,
                  "properties": {
                     "type": { "enum": [ "AxisExtent"] },
                     "id":  { "type": "string" },
                     "axisLabel":  { "type": "string" },
                     "lowerBound":  { "type": ["number", "string", "null", "boolean"] },
                     "upperBound": { "type": ["number", "string", "null", "boolean"] },
                     "uomLabel": { "type": "string" }
                  }
               }
            }
         }
      },
      "domainSet": {
         "title": "domainSet",
         "description": "The domainSet describes the *direct positions* of the coverage, i.e., the locations for which values are available.",
         "type": "object",
         "oneOf" : [
         {
            "required": [ "type", "generalGrid"],
            "properties": {
               "type": { "enum": [ "DomainSet"] },
               "generalGrid":{
                  "title": "General Grid",
                  "description": "A general n-D grid is defined through a sequence of axes, each of which can be of a particular axis type.",
                  "type": "object",
                  "required": [ "type"],
                  "additionalProperties": false,
                  "properties": {
                     "type": { "enum": [ "GeneralGridCoverage"] },
                     "id":  { "type": "string" },
                     "srsName": { "type": "string", "format": "uri"},
                     "axisLabels":
                     {
                        "type": "array",
                        "items": { "type": "string" }
                     },
                     "axis": {
                        "type": "array",
                        "items": {
                           "type": "object",
                           "oneOf" : [
                              {
                                 "title": "Index Axis",
                                 "description": "An Index Axis is an axis with only integer positions allowed.",
                                 "required": [ "type", "axisLabel", "lowerBound", "upperBound"],
                                 "additionalProperties": false,
                                 "properties": {
                                    "type": { "enum": [ "IndexAxis"] },
                                    "id":  { "type": "string" },
                                    "axisLabel":  { "type": "string" },
                                    "lowerBound":  { "type": "number" },
                                    "upperBound": { "type": "number" }
                                 }
                              },{
                                 "title": "Regular Axis",
                                 "description": "A Regular Axis is an axis where all direct coordinates are at a common distance from its immediate neighbors.",
                                 "required": [ "type", "axisLabel", "lowerBound", "upperBound", "resolution", "uomLabel"],
                                 "additionalProperties": false,
                                 "properties": {
                                    "type": { "enum": [ "RegularAxis"] },
                                    "id":  { "type": "string" },
                                    "axisLabel":  { "type": "string" },
                                    "lowerBound":  { "type": ["number", "string", "null", "boolean"] },
                                    "upperBound": { "type": ["number", "string", "null", "boolean"] },
                                    "uomLabel": { "type": "string" },
                                    "resolution": { "type": "number" }
                                 }
                              },{
                                 "title": "Irregular Axis",
                                 "description": "An irregular axis enumerates all possible direct position coordinates.",
                                 "required": [ "type", "axisLabel", "uomLabel", "coordinate"],
                                 "additionalProperties": false,
                                 "properties": {
                                    "type": { "enum": [ "IrregularAxis"] },
                                    "id":  { "type": "string" },
                                    "axisLabel":  { "type": "string" },
                                    "uomLabel": { "type": "string" },
                                    "coordinate": {
                                       "type": "array",
                                       "items": { "type": ["number", "string", "boolean"] }
                                    }
                                 }
                              }
                           ]
                        }
                     },
                     "displacement": {
                        "title": "Displacement",
                        "description": "A Displacement is a warped axis nest where points on the grid all have their individual direct position coordinates. The sequenceRule element describes linearization order.",
                        "type": "object",
                        "oneOf": [
                        {
                           "required": ["type", "axisLabels", "uomLabels", "coordinates" ],
                           "properties": {
                              "type": { "enum": [ "DisplacementAxisNest"] },
                              "id":  { "type": "string" },
                              "axisLabel":  { "type": "string" },
                              "srsName": { "type": "string", "format": "uri"},
                              "axisLabels":
                              {
                                 "type": "array",
                                 "items": { "type": "string" }
                              },
                              "uomLabels":
                              {
                                 "type": "array",
                                 "items": { "type": "string" }
                              },
                              "coordinates": {
                                 "type": "array",
                                 "items": {
                                    "type": "array",
                                    "items": { "type": ["number", "string", "boolean"] }
                                 }
                              }
                           }
                        },{
                           "required": ["type", "axisLabels", "uomLabels", "coordinatesRef"],
                           "properties": {
                              "type": { "enum": [ "DisplacementAxisNestRef"] },
                              "id":  { "type": "string" },
                              "axisLabel":  { "type": "string" },
                              "srsName": { "type": "string", "format": "uri"},
                              "axisLabels":
                              {
                                 "type": "array",
                                 "items": { "type": "string" }
                              },
                              "uomLabels":
                              {
                                 "type": "array",
                                 "items": { "type": "string" }
                              },
                              "coordinatesRef": { "type": "string", "format": "uri"}
                           }
                        }]
                     },
                     "model": {
                        "title": "Sensor model",
                        "description": "A Transformation By Sensor Model is a transformation definition which is given by a SensorML 2.0 transformation specification.",
                        "type": "object",
                        "required": [ "type", "sensorModelRef" ],
                        "properties": {
                           "type": { "enum": [ "TransformationBySensorModel"] },
                           "id":  { "type": "string" },
                           "axisLabels":
                           {
                              "type": "array",
                              "items": { "type": "string" }
                           },
                           "uomLabels":
                           {
                              "type": "array",
                              "items": { "type": "string" }
                           },
                           "sensorModelRef": { "type": "string", "format": "uri"},
                           "sensorInstanceRef": { "type": "string", "format": "uri"}
                        }
                     },
                     "gridLimits": {
                        "title": "Grid limits",
                        "description": "This is the boundary of the array underlying the grid, given by its diagonal corner points in integer _60_3D. The grid limits can be omitted in case all axes are of type index axis, because then it repeats the grid information in a redundant way. The purpose of the axisLabels attribute, which lists the axis labels of all axisExtent elements in proper sequence, is to enforce axis sequence also in XML systems which do not preserve document order.",
                        "type": "object",
                        "required": [ "type"],
                        "properties": {
                           "type": { "enum": [ "GridLimits" ] },
                           "indexAxis": {
                              "title": "Index Axis",
                              "description": "An Index Axis is an axis with only integer positions allowed.",
                              "type": "object",
                              "required": [ "type", "lowerBound", "upperBound"],
                              "additionalProperties": false,
                              "properties": {
                                 "type": { "enum": [ "IndexAxis"] },
                                 "id":  { "type": "string" },
                                 "axisLabel":  { "type": "string" },
                                 "lowerBound":  { "type": "number" },
                                 "upperBound": { "type": "number" }
                              }
                           },
                           "srsName": { "type": "string", "format": "uri"},
                           "axisLabels":
                           {
                              "type": "array",
                              "items": { "type": "string" }
                           }
                        }
                     }
                  }
               }
            }
         },{
            "required": [ "type", "directMultiPoint"],
            "properties": {
               "type": { "enum": [ "DomainSet"] },
               "directMultiPoint":{
                  "oneOf" : [{
                     "required": [ "type", "coordinates" ],
                     "properties": {
                        "type": { "enum": [ "DirectMultiPoint"] },
                        "coordinates": {
                           "type": "array",
                           "items": {
                              "type": "array",
                              "items": { "type": ["number", "string", "boolean"] }
                           }
                        }
                     }
                  },{
                     "required": [ "type", "coordinatesRef" ],
                     "properties": {
                        "type": { "enum": [ "DirectMultiPointTypeRef"] },
                        "coordinatesRef": { "type": "string", "format": "uri"}
                     }
                  }]
               }
            }
         },{
            "required": [ "type", "fileReference"],
            "properties": {
               "type": { "enum": [ "DomainSetRef"] },
               "id": { "type": "string" , "format":"uri"},
               "fileReference": { "type": "string", "format": "uri"}
            }
         }]
      },
      "rangeSet": {
         "title": "rangeSet",
         "description": "The rangeSet lists a value for each of the coverage's direct positions. Values resemble the *payload* information of some particular direct positions. Values can be composite (with a single nesting level, i.e.: composites always consist of atomics), or atomic (emulated through single-component composites) whereby the sequence, structure, and meaning of every value is defined through the rangeType. Values can be represented in-line or by reference to an external file which may have any suitable encoding.",
         "type": "object",
         "oneOf" : [{
            "required": [ "type", "dataBlock"],
            "properties": {
               "type": { "enum": [ "RangeSet"] },
               "dataBlock":{
                  "title": "dataBlock",
                  "description": "Data block objects",
                  "type": "object",
                  "required": [ "type", "values"],
                  "properties": {
                     "type": { "enum": [ "VDataBlock", "CVDataBlock"] },
                     "values": {
                        "type": "array",
                        "items": { "type": ["number", "string", "null", "boolean"] }
                     }
                  }
               }
            }
         },
         {
            "required": [ "type", "fileReference"],
            "properties": {
               "type": { "enum": [ "RangeSetRef"] },
               "fileReference": {
                  "type": "array",
                  "items": { "type": "string", "format": "uri" }
               }
            }
         }]
      },
      "partitionSet": {
         "title": "Partitioning Set",
         "description": "A partition describes how a coverage (*sub-coverage*) referenced is located within referencing coverage (*super-coverage*). The sub-coverage can be represented by referencing a coverage id or a URL pointing to a coverage.  Such sub-coverages referenced may be grouped into the super-coverage document, or reside remote, or mixed. As an additional alternative, single range values can be indicated verbatimg, together with their direct position. All values must share an identical structure and conform to the rangeType definition.",
         "type": "object",
         "required": [ "type"],
         "properties": {
            "type": { "enum": [ "PartitionSet"] },
            "partition":{
               "type": "array",
               "items": {
                  "type": "object",
                  "oneOf" : [{
                     "required": [ "type", "coverageRef"],
                     "properties": {
                        "id": { "type": "string"},
                        "type": { "enum": [ "PartitionRef" ] },
                        "envelope": { "$ref": "#/definitions/envelope" },
                        "coverageRef": { "type": "string", "format": "uri"}
                     }
                  },{
                     "required": [ "type", "coverage"],
                     "properties": {
                        "id": { "type": "string"},
                        "type": { "enum": [ "Partition" ] },
                        "envelope": { "$ref": "#/definitions/envelope" },
                        "coverage": { "$ref": "#" }
                     }
                  }]
               }
            },
            "positionValuePair": {
               "type": "array",
               "items": {
                  "type": "object",
                  "required": [ "type", "coordinate", "value" ],
                  "properties": {
                     "id": { "type": "string"},
                     "type": { "enum": [ "PVP" ] },
                     "coordinate": {
                        "type": "array",
                        "items": { "type": ["number", "string", "boolean"] }
                     },
                     "value": {
                        "type": "array",
                        "items": { "type": ["number", "string", "null", "boolean"] }
                     }
                  }
               }
            }
         }
      },
      "rangeType": {
         "title": "rangeType",
         "description": "The rangeType element describes the structure and semantics of a coverage's range values, including (optionally) restrictions on the interpolation allowed on such values.",
         "type": "object",
         "oneOf": [{
            "required": [ "type", "field"],
            "properties": {
               "type": { "enum": [ "DataRecord"] },
               "field":{
                  "type": "array",
                  "items": {
                     "title": "DataRecord field",
                     "description": "e.g. Quantity or Count",
                     "type": "object",
                     "required": [ "type"],
                     "properties": {
                        "type": { "enum": [ "Quantity", "Count" ] },
                        "id": { "type": "string" , "format":"uri"},
                        "name": { "type": "string" },
                        "definition": { "type": "string", "format":"uri" },
                        "description": { "type": "string" },
                        "uom": {
                           "title": "units of measure",
                           "description": "units of measure",
                           "type": "object",
                           "required": [ "type", "code"],
                           "properties": {
                              "type": { "enum": [ "UnitReference"] },
                              "id": { "type": "string" , "format":"uri"},
                              "code":{ "type": "string" }
                           }
                        },
                        "constraint": {
                           "title": "Constraint",
                           "description": "Constraint",
                           "type": "object",
                           "required": [ "type" ],
                           "properties": {
                              "type": { "enum": [ "AllowedValues"] },
                              "id": { "type": "string" , "format":"uri"},
                              "interval":{
                                 "type": "array",
                                 "items": { "type": ["number", "string", "boolean"] }
                              }
                           }
                        }
                     }
                  }
               },
               "interpolationRestriction": {
                  "title": "interpolationRestriction",
                  "description": "Interpolation restriction",
                  "type": "object",
                  "required": [ "type"],
                  "properties": {
                     "type": { "enum": [ "InterpolationRestriction"] },
                     "id": { "type": "string" , "format":"uri"},
                     "allowedInterpolation": {
                        "type": "array",
                        "items": { "type": "string", "format": "uri"}
                     }
                  }
               }
            }
         },{
            "required": [ "type", "fileReference" ],
            "properties": {
               "type": { "enum": [ "RangeTypeRef"] },
               "id": { "type": "string" , "format":"uri"},
               "fileReference": { "type": "string", "format": "uri" }
            }
         }]
      },
      "metadata": {
         "title": "Metadata",
         "description": "The metadata element is a container of any (not further specified) information which should be transported along with the coverage on hand, such as domain-specific metadata.",
         "type": "object"
      }
   }
}