Commit 44889a90 authored by Jeff Yutzler's avatar Jeff Yutzler
Browse files

leaving breadcrumbs to show where file has moved to

parent 7a0561cb
......@@ -3,76 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/10-metadata-manifest.adoc.
====
==== Extension Title
Manifest Metadata Profile
==== Introduction
A metadata profile establishes rules for using the link:http://www.geopackage.org/spec121/#extension_metadata[Metadata Extension] to meet a specific purpose.
This profile indicates how to present the metadata describing a manifest, or in other words the elements that are in use in the GeoPackage.
The metadata document itself is a JSON document with a new schema developed specifically for this purpose.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_metadata_manifest` (will become `gpkg_metadata_manifest` if adopted by OGC)
==== Extension Type
New requirement dependent on link:http://www.geopackage.org/spec121/#extension_metadata[GeoPackage Metadata Extension]
and link:7-metadata-profiles.adoc[Metadata Profiles].
==== Applicability
This extension allows for the the storage of a manifest as a metadata object.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following row to this table.
[[im_metadata_manifest_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |`metadata` |`im_metadata_manifest` |_a reference to this file_ |`metadata`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[im_metadata_styles_metadata]]
===== `gpkg_metadata`
For every dataset, add a row to the `gpkg_metadata` table with the following values:
* `id` is a primary key
* `md_scope` "manifest"
* `md_standard_uri` "https://gitlab.com/imagemattersllc/ogc-tb-15-opf/blob/master/schema/manifest-schema.json"
* `mime_type` "application/json"
* `metadata` the actual metadata document
[[im_metadata_styles_metadata_references]]
===== `gpkg_metadata_references`
For every dataset, add a row to the `gpkg_metadata_references` table with the following values:
* `reference_scope` "geopackage"
* `table_name` null
* `column_name` null
* `row_id_value` null
* `timestamp` strftime(\'%Y-%m-%dT%H:%M:%fZ', \'now')
* `md_file_id` the `gpkg_metadata.id` for that metadata document
* `md_parent_id` null
......@@ -3,76 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/11-metadata-styles.adoc.
====
==== Extension Title
Styles Metadata Profile
==== Introduction
A metadata profile establishes rules for using the link:http://www.geopackage.org/spec121/#extension_metadata[Metadata Extension] to meet a specific purpose.
This profile indicates how to present the metadata describing a specific stylesheet as per the link:5-sse.adoc[Styles and Symbology Extension].
The specification for the metadata document itself is currently under development, but the working draft is currently available at https://app.swaggerhub.com/apis/cportele/opf-style-api/1.0.0#/Use%20styles/getStyleMetadata.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_metadata_styles` (will become `gpkg_metadata_styles` if adopted by OGC)
==== Extension Type
New requirement dependent on link:http://www.geopackage.org/spec121/#extension_metadata[GeoPackage Metadata Extension]
and link:7-metadata-profiles.adoc[Metadata Profiles].
==== Applicability
This extension allows for the the storage of metadata pertaining to a specific stylesheet.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following row to this table.
[[im_metadata_styles_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |`metadata` |`im_metadata_styles` |_a reference to this file_ |`metadata`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[im_metadata_styles_metadata]]
===== `gpkg_metadata`
For every stylesheet, add a row to the `gpkg_metadata` table with the following values:
* `id` is a primary key
* `md_scope` "style"
* `md_standard_uri` "https://app.swaggerhub.com/apis/cportele/opf-style-api/1.0.0#/Use%20styles/getStyleMetadata"
* `mime_type` "application/json"
* `metadata` the actual metadata document
[[im_metadata_styles_metadata_references]]
===== `gpkg_metadata_references`
For every stylesheet, add a row to the `gpkg_metadata_references` table with the following values:
* `reference_scope` "row"
* `table_name` "gpkgext_stylesheets"
* `column_name` null
* `row_id_value` the `gpkgext_stylesheets.id` value for that stylesheet
* `timestamp` strftime(\'%Y-%m-%dT%H:%M:%fZ', \'now')
* `md_file_id` the `gpkg_metadata.id` for that metadata document
* `md_parent_id` null
......@@ -3,76 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/12-metadata-dataset-stac.adoc.
====
==== Extension Title
Dataset Provenance STAC Metadata Profile
==== Introduction
A metadata profile establishes rules for using the link:http://www.geopackage.org/spec121/#extension_metadata[Metadata Extension] to meet a specific purpose.
This profile indicates how to present the metadata describing the provenance of a specific dataset.
The metadata document itself is a STAC Item as per the link:https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md[STAC specification].
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_metadata_dataset_stac` (will become `gpkg_metadata_dataset_stac` if adopted by OGC)
==== Extension Type
New requirement dependent on link:http://www.geopackage.org/spec121/#extension_metadata[GeoPackage Metadata Extension]
and link:7-metadata-profiles.adoc[Metadata Profiles].
==== Applicability
This extension allows for the storage of metadata pertaining to the provenance of a specific dataset.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following row to this table.
[[im_metadata_dataset_provenance_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |`metadata` |`im_metadata_dataset_stac` |_a reference to this file_ |`metadata`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[im_metadata_dataset_stac_metadata]]
===== `gpkg_metadata`
For every dataset, add a row to the `gpkg_metadata` table with the following values:
* `id` is a primary key
* `md_scope` "dataset"
* `md_standard_uri` "https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md"
* `mime_type` "application/json"
* `metadata` the actual metadata document
[[im_metadata_styles_metadata_references]]
===== `gpkg_metadata_references`
For every dataset, add a row to the `gpkg_metadata_references` table with the following values:
* `reference_scope` "row"
* `table_name` the `gpkg_contents.table_name` for that dataset
* `column_name` null
* `row_id_value` null
* `timestamp` strftime(\'%Y-%m-%dT%H:%M:%fZ', \'now')
* `md_file_id` the `gpkg_metadata.id` for that metadata document
* `md_parent_id` null
......@@ -3,84 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/13-semantic-annotations.adoc.
====
==== Extension Title
Semantic Annotations Extension
==== Introduction
A semantic annotation is a semantically grounded term that can be applied to another concept.
Use of this extension enables semantic annotations to be applied to any business object in the current GeoPackage.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_semantic_annotations` (will become `gpkg_semantic_annotations` if adopted by OGC)
==== Extension Type
New requirement dependent on http://docs.opengeospatial.org/is/18-000/18-000.html[GeoPackage Related Tables Extension] (RTE) and optionally link:http://www.geopackage.org/spec121/#extension_schema[GeoPackage Schema Extension].
==== Applicability
This extension can be applied to any GeoPackage business object (layers, features, tiles, styles, etc.).
==== Scope
read-write
==== Specification
===== `gpkg_contents`
To use this extension, add the following row to this table.
[[im_semantic_annotations_gcr_table]]
.gpkg_contents table row
[cols=",,,,,",options="header",]
|====
| table_name | data_type | identifier | description | last_change | _others_
|`gpkgext_semantic_annotations` |"attributes" | "semantic annotations" | _any_ | _any_ | null
|====
===== `gpkg_extensions`
To use this extension, add the following rows to this table in addition to the rows required for the Related Tables Extension and Schema Extension (if used).
[[im_semantic_annotations_ger_table]]
.gpkg_extensions table row
[cols=",,,,",options="header",]
|====
| table_name | column_name | extension_name | definition | scope
|`gpkgext_semantic_annotations` |null |`im_semantic_annotations` |_a reference to this file_ |`read-write`
|====
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[gpkgext_semantic_annotations]]
===== `gpkgext_semantic_annotations`
When this extension is in use, add a table with this name and the following columns:
* `id` is a primary key
* `type` is a semantically grounded type (category) for the annotation
* `title` is a human-readable title for the annotation
* `description` is an optional human-readable text description for the annotation
* `uri` is the resolvable URI for the semantic concept
==== Using Semantic Annotations
To use semantic annotations, do the following:
. Add rows to `gpkgext_semantic_annotations` for every annotation you want to use.
.. Optionally, use the Schema Extension to establish an enumeration for the types and further describe those types. See http://www.geopackage.org/guidance/extensions/schema.html for more details.
. Make a "related tables" relationship (as per http://www.geopackage.org/guidance/extensions/related_tables.html) between any business object table (base table) and `gpkgext_semantic_annotations` (related table).
** The base_primary_column must be an integer. For tables like `gpkg_contents` with a non-integer primary key, you can use `rowid` instead.
** The `relation_name` is "simple_attributes".
** The `mapping_table_name` may be any valid, available table name. Create the table and add a row `gpkg_extensions` with that table name as required by the RTE.
. Add a row to the mapping table for each instance of the annotation. As with other RTE relationships, there may be a many-to-many relationship between the business objects and the semantic annotations.
......@@ -3,86 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
====
==== Extension Title
Styles
==== Introduction
This extension provides a mechanism for styles in a GeoPackage.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15, the OGC Vector Tiles Pilot, and the OWS Context SWG.
==== Extension Name or Template
`im_styles` (will become `gpkg_styles` if adopted by OGC)
==== Extension Type
New requirement dependent on http://www.geopackage.org/spec/#core[GeoPackage Core (Clause 1)].
==== Applicability
This extension allows for stylesheets to be stored in a GeoPackage.
How those stylesheets are used is outside of the scope of this specification, but they could be incorporated into OWS Context (see <<owscontext_extension>>.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following rows to this table.
[[im_styles_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkgext_stylesheets` |null |`im_styles` |_a reference to this file_ |`read-write`
|`gpkgext_symbols` |null |`im_styles` |_a reference to this file_ |`read-write`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[gpkgext_stylesheets]]
===== `gpkgext_stylesheets`
This table contains stylesheets, organized by style set and option.
The columns of this table are:
* `id` is a primary key
* [line-through]#`layer_set` is text defining a layer set that is suitable for styling in a common way#
* `style` is text describing a specific implementation for a layer set
* `format` is the format of the stylesheet (e.g., `mbstyle` or `sld`)
* `stylesheet` is the actual stylesheet text
* `title` is an optional text title
* `description` is an optional text description
* `uri` is an optional resolvable URI
[[gpkgext_symbols]]
===== `gpkgext_symbols`
This table contains symbols, organized by style set and option.
The columns of this table are:
* `id` is a primary key
* `symbol_id` is an string identifier such as a URI that can uniquely identify the symbol
* `content_type` is the media type (formerly MIME type, e.g., `image/svg+xml` or `image/png`) of the symbol
* `symbol` is the actual symbol BLOB
* `title` is an optional text title
* `description` is an optional text description
* `uri` is an optional resolvable URI
[NOTE]
====
As with other GeoPackage tables, this specification takes no position on how either of these tables are to be used by a client.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/5-sse.adoc.
====
......@@ -3,64 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/6-owce.adoc.
====
==== Extension Title
OWS Context
==== Introduction
This extension provides a mechanism for storing http://owscontext.org[OWS Context] content in a GeoPackage using the standard link:https://portal.opengeospatial.org/files/?artifact_id=55183[ATOM] or link:https://portal.opengeospatial.org/files/?artifact_id=68826[GeoJSON] encoding.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15, the OGC Vector Tiles Pilot, and the OWS Context SWG.
==== Extension Name or Template
`im_ows_context` (will become `gpkg_ows_context` if adopted by OGC)
==== Extension Type
New requirement dependent on http://www.geopackage.org/spec/#core[GeoPackage Core (Clause 1)].
==== Applicability
This extension adds an additional level of organization to existing GeoPackage data.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following row to this table.
[[im_ows_context_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkgext_contexts` |null |`im_ows_context` |_a reference to this file_ |`read-write`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[gpkgext_contexts]]
===== `gpkgext_contexts`
This table describes OWS Context instances.
The columns of this table are:
* `id` is a primary key
* `name` is a text label for the context
* `format` is the format of the context (e.g., `atom` or `geojson`)
* `context` is the actual context text
* `title` is an optional text title designed to be human-readable
* `description` is an optional text description designed to be human-readable
* `parent_id` is a key to another context document that serves as the parent (to allow nesting)
......@@ -3,72 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
====
==== Extension Title
Metadata Profiles Extension
==== Introduction
A metadata profile establishes rules for using the link:http://www.geopackage.org/spec121/#extension_metadata[Metadata Extension] to meet a specific purpose.
Use of this extension signifies that metadata profiles are in use in the current GeoPackage.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_metadata_profiles` (will become `gpkg_metadata_profiles` if adopted by OGC)
==== Extension Type
New requirement dependent on link:http://www.geopackage.org/spec121/#extension_metadata[GeoPackage Metadata Extension] and extending link:http://www.geopackage.org/spec121/#r64[Requirement 64].
==== Applicability
This extension allows for the definition of metadata profiles to describe a particular class of metadata use.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following rows to this table in addition to the rows required for the Metadata Extension and any metadata profiles.
[[im_metadata_profiles_ger_table]]
.gpkg_extensions table row
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |null |`im_metadata_profiles` |_a reference to this file_ |`read-write`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
==== Creating New Metadata Profiles
To create a new metadata profile, write a new extension specifying the following:
. A row in `gpkg_extensions` with the values as per <<im_metadata_profile_ger_table>>
. The values for the `md_scope`, `md_standard_uri`, and `mime_type` columns of `gpkg_metadata` that jointly identify this particular profile
. The allowed values for the `reference_scope` column of `gpkg_metadata_references`
[[im_metadata_profile_ger_table]]
.gpkg_extensions table row for a metadata profile
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |`metadata` |_an extension name_ |_a reference to this file_ |`metadata`
|========================================================================================================================================================================
[NOTE]
====
Before this extension, `gpkg_extensions.scope` values were limited to "read-write" and "write-only".
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/7-metadata-profiles.adoc.
====
......@@ -3,77 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/8-metadata-dataset-provenance.adoc.
====
==== Extension Title
Dataset Provenance Metadata Profile
==== Introduction
A metadata profile establishes rules for using the link:http://www.geopackage.org/spec121/#extension_metadata[Metadata Extension] to meet a specific purpose.
This profile indicates how to present the metadata describing the provenance of a specific dataset.
The metadata document itself is a GeoJSON-encoded OWS Context as per the link:https://portal.opengeospatial.org/files/?artifact_id=68826[OWS Context GeoJSON Encoding Standard].
The FeatureCollection in this document will have citation information in the properties object and a single Feature object that indicates where the dataset was derived from.
==== Extension Author
Image Matters LLC, in collaboration with the participants of OGC Testbed-15.
==== Extension Name or Template
`im_metadata_dataset_provenance` (will become `gpkg_metadata_dataset_provenance` if adopted by OGC)
==== Extension Type
New requirement dependent on link:http://www.geopackage.org/spec121/#extension_metadata[GeoPackage Metadata Extension]
and link:7-metadata-profiles.adoc[Metadata Profiles].
==== Applicability
This extension allows for the storage of metadata pertaining to the provenance of a specific dataset.
==== Scope
read-write
==== Specification
===== `gpkg_extensions`
To use this extension, add the following row to this table.
[[im_metadata_dataset_provenance_ger_table]]
.gpkg_extensions Table Rows
[cols=",,,,",options="header",]
|========================================================================================================================================================================
| table_name | column_name | extension_name | definition | scope
|`gpkg_metadata` |`metadata` |`im_metadata_dataset_provenance` |_a reference to this file_ |`metadata`
|========================================================================================================================================================================
[NOTE]
==========
The values in the `definition` column SHOULD refer in some human-readable way to this extension specification. If the extension is adopted by OGC, it will gain the "gpkg_" prefix and get a different definition permalink.
==========
[[im_metadata_dataset_provenance_metadata]]
===== `gpkg_metadata`
For every dataset, add a row to the `gpkg_metadata` table with the following values:
* `id` is a primary key
* `md_scope` "dataset"
* `md_standard_uri` "https://portal.opengeospatial.org/files/?artifact_id=68826"
* `mime_type` "application/json"
* `metadata` the actual metadata document
[[im_metadata_styles_metadata_references]]
===== `gpkg_metadata_references`
For every dataset, add a row to the `gpkg_metadata_references` table with the following values:
* `reference_scope` "row"
* `table_name` the `gpkg_contents.table_name` for that dataset
* `column_name` null
* `row_id_value` null
* `timestamp` strftime(\'%Y-%m-%dT%H:%M:%fZ', \'now')
* `md_file_id` the `gpkg_metadata.id` for that metadata document
* `md_parent_id` null
......@@ -3,77 +3,5 @@
[WARNING]
====
This subsection is under discussion and may change radically.
This file has moved. See https://gitlab.com/imagemattersllc/geopackage-metadata-profiles/blob/master/extensions/9-metadata-updates.adoc.
====
==== Extension Title
Updates Metadata Profile