:tocdepth: 3 :py:mod:`gws.base.metadata` =========================== .. py:module:: gws.base.metadata .. autoapi-nested-parse:: OWS and ISO-19115 metadata. The metadata structure as defined here is based on: - ISO 19115:2003 Geographic information -- Metadata - ISO 19139 - Geographic Information - Metadata - XML Schema Implementation - OGC Web Services Common Standard OGC 06-121r9 - Web Map Server Implementation Specification OGC 06-042 - Web Feature Service 2.0 Interface Standard OGC 09-025r1 **Source code:** :source:`gws.base.metadata` Submodules ---------- .. toctree:: :titlesonly: :maxdepth: 1 core/index.rst inspire/index.rst iso/index.rst Package Contents ---------------- .. py:class:: Config(*args, **kwargs) Bases: :py:obj:`gws.Config` Metadata configuration. (added in 8.2) .. py:attribute:: abstract :type: Optional[str] Object abstract, a brief description of the object. .. py:attribute:: accessConstraints :type: Optional[str] Access constraint for the object. .. py:attribute:: accessConstraintsType :type: Optional[str] Access constraint type for the object. .. py:attribute:: attribution :type: Optional[str] Attribution information for the object. .. py:attribute:: attributionUrl :type: Optional[str] Attribution URL for the object. .. py:attribute:: authorityIdentifier :type: Optional[str] Identifier (WMS) .. py:attribute:: authorityName :type: Optional[str] AuthorityURL name (WMS) .. py:attribute:: authorityUrl :type: Optional[str] AuthorityURL (WMS) .. py:attribute:: catalogCitationUid :type: Optional[str] CI_Citation.Identifier (CSW). .. py:attribute:: catalogUid :type: Optional[str] MD_Metadata.Identifier (CSW). .. py:attribute:: contactAddress :type: Optional[str] Contact address for the object. .. py:attribute:: contactAddressType :type: Optional[str] Type of contact address, such as 'postal' or 'email'. .. py:attribute:: contactArea :type: Optional[str] Contact area or state. .. py:attribute:: contactCity :type: Optional[str] Contact city. .. py:attribute:: contactCountry :type: Optional[str] Contact country. .. py:attribute:: contactEmail :type: Optional[str] Contact email address. .. py:attribute:: contactFax :type: Optional[str] Contact fax number. .. py:attribute:: contactOrganization :type: Optional[str] Contact organization or institution. .. py:attribute:: contactPerson :type: Optional[str] Contact person name. .. py:attribute:: contactPhone :type: Optional[str] Contact phone number. .. py:attribute:: contactPosition :type: Optional[str] Contact position or job title. .. py:attribute:: contactProviderName :type: Optional[str] Name of the provider of the contact information. .. py:attribute:: contactProviderSite :type: Optional[str] Website of the provider of the contact information. .. py:attribute:: contactRole :type: Optional[gws.base.metadata.iso.CI_RoleCode] Role of the contact person, such as 'pointOfContact' or 'author'. .. py:attribute:: contactUrl :type: Optional[str] URL for additional contact information. .. py:attribute:: contactZip :type: Optional[str] Contact postal code. .. py:attribute:: crs :type: Optional[gws.CrsName] MD_ReferenceSystem (ISO). .. py:attribute:: dateCreated :type: Optional[gws.DateStr] Object creation date. .. py:attribute:: dateUpdated :type: Optional[gws.DateStr] Object last update date. .. py:attribute:: fees :type: Optional[str] Fees associated with accessing or using the object. .. py:attribute:: image :type: Optional[str] Image URL or path associated with the object. .. py:attribute:: inspireDegreeOfConformity :type: Optional[gws.base.metadata.inspire.IM_DegreeOfConformity] .. py:attribute:: inspireMandatoryKeyword :type: Optional[gws.base.metadata.inspire.IM_MandatoryKeyword] .. py:attribute:: inspireResourceType :type: Optional[gws.base.metadata.inspire.IM_ResourceType] .. py:attribute:: inspireSpatialDataServiceType :type: Optional[gws.base.metadata.inspire.IM_SpatialDataServiceType] .. py:attribute:: inspireSpatialScope :type: Optional[gws.base.metadata.inspire.IM_SpatialScope] .. py:attribute:: inspireSpatialScopeName :type: Optional[str] .. py:attribute:: inspireTheme :type: Optional[gws.base.metadata.inspire.IM_Theme] .. py:attribute:: isoMaintenanceFrequencyCode :type: Optional[gws.base.metadata.iso.MD_MaintenanceFrequencyCode] .. py:attribute:: isoQualityConformanceExplanation :type: Optional[str] .. py:attribute:: isoQualityConformanceQualityPass :type: Optional[bool] .. py:attribute:: isoQualityConformanceSpecificationDate :type: Optional[str] .. py:attribute:: isoQualityConformanceSpecificationTitle :type: Optional[str] .. py:attribute:: isoQualityLineageSource :type: Optional[str] .. py:attribute:: isoQualityLineageSourceScale :type: Optional[int] .. py:attribute:: isoQualityLineageStatement :type: Optional[str] .. py:attribute:: isoRestrictionCode :type: Optional[gws.base.metadata.iso.MD_RestrictionCode] .. py:attribute:: isoScope :type: Optional[gws.base.metadata.iso.MD_ScopeCode] .. py:attribute:: isoScopeName :type: Optional[str] .. py:attribute:: isoServiceFunction :type: Optional[gws.base.metadata.iso.SV_ServiceFunction] .. py:attribute:: isoSpatialRepresentationType :type: Optional[gws.base.metadata.iso.MD_SpatialRepresentationTypeCode] .. py:attribute:: isoSpatialResolution :type: Optional[str] .. py:attribute:: isoTopicCategories :type: Optional[list[gws.base.metadata.iso.MD_TopicCategoryCode]] .. py:attribute:: keywords :type: Optional[list[str]] river'. :type: Keywords, optionally prefixed with a vocabulary, e.g. 'gemet .. py:attribute:: language :type: Optional[str] Language code (ISO 639-1). .. py:attribute:: license :type: Optional[str] License information for the object. .. py:attribute:: licenseUrl :type: Optional[gws.Url] License URL. .. py:attribute:: metaLinks :type: Optional[list[LinkConfig]] MetadataURL (WMS, WFS) or metadata links (CSW). .. py:attribute:: name :type: Optional[str] Object name. .. py:attribute:: parentIdentifier :type: Optional[str] MD_Metadata.parentIdentifier (ISO). .. py:attribute:: serviceMetadataURL :type: Optional[str] Service metadata URL (WMTS). .. py:attribute:: temporalBegin :type: Optional[gws.DateStr] EX_TemporalExtent (ISO). .. py:attribute:: temporalEnd :type: Optional[gws.DateStr] EX_TemporalExtent (ISO). .. py:attribute:: title :type: Optional[str] Object title. .. py:attribute:: wgsExtent :type: Optional[gws.Extent] EX_Extent (ISO). .. py:function:: from_args(*args, **kwargs) -> gws.Metadata Create a Metadata object from arguments (dicts or other Metadata objects). .. py:function:: from_config(c: gws.Config) -> gws.Metadata Create a Metadata object from a configuration. :param c: Configuration object. .. py:function:: from_dict(d: dict) -> gws.Metadata Create a Metadata object from a dictionary. :param d: Dictionary containing metadata information. .. py:function:: from_props(p: gws.Props) -> gws.Metadata Create a Metadata object from properties. :param p: Properties object. .. py:function:: keyword_groups(md: gws.Metadata) -> list[KeywordGroup] .. py:class:: KeywordGroup(*args, **kwargs) Bases: :py:obj:`gws.Data` Basic data object. This object can be instantiated by passing one or or ``dict`` arguments and/or keyword args. All dicts keys and keywords become attributes of the object. Accessing an undefined attribute returns ``None`` and no error is raised, unless the attribute name starts with an underscore. .. py:attribute:: codeSpace :type: str Code space for the keyword group, e.g. 'iso', 'gemet', 'inspire', 'gcmd'. .. py:attribute:: keywords :type: list[str] List of keywords in the group. .. py:attribute:: typeName :type: str Type name for the keyword group, e.g. 'isoTopicCategories', 'keywords'. .. py:function:: new() -> gws.Metadata Create a new Metadata object with default values. .. py:class:: Props(*args, **kwargs) Bases: :py:obj:`gws.Props` Represents metadata properties. .. py:attribute:: abstract :type: str .. py:attribute:: attribution :type: str .. py:attribute:: dateCreated :type: str .. py:attribute:: dateUpdated :type: str .. py:attribute:: keywords :type: list[str] .. py:attribute:: language :type: str .. py:attribute:: title :type: str .. py:function:: props(md: gws.Metadata) -> gws.Props Properties of a Metadata object. .. py:function:: update(md: gws.Metadata, *args, **kwargs) -> gws.Metadata Update a Metadata object from arguments (dicts or other Metadata objects).