Skip to content

maintenance module

This is the maintenance module.

This module contains geographic metadata structures regarding data maintenance derived from the ISO 19115-1:2014 international standard.

MaintenanceFrequencyCode

Bases: Enum

Frequency with which modifications and deletions are made to the data after it is first produced

Source code in opengis/metadata/maintenance.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class MaintenanceFrequencyCode(Enum):
    """
    Frequency with which modifications and deletions are made to the data
    after it is first produced
    """

    CONTINUAL = "continual"
    """Resource is repeatedly and frequentlyupdated."""

    DAILY = "daily"
    """Resource is updated each day"""

    WEEKLY = "weekly"
    """Resource is updated on a weekly basis."""

    FORTNIGHTLY = "fortnightly"
    """Resource is updated every two weeks."""

    MONTHLY = "monthly"
    """Resource is updated each month."""

    QUARTERLY = "quarterly"
    """Resource is updatedevery three months."""

    BIANNUALLY = "biannually"
    """Resource is updated twice each year."""

    ANNUALLY = "annually"
    """Resource is updated every year."""

    AS_NEEDED = "asNeeded"
    """Resource is updated as deemed necessary."""

    IRREGULAR = "irregular"
    """Resource is updated in intervals that are uneven in duration."""

    NOT_PLANNED = "notPlanned"
    """There are no plans to update the data."""

    UNKNOWN = "unknown"
    """Frequency of maintenance for the data is not known."""

    PERIODIC = "periodic"
    """Resource is updated at regular intervals."""

    SEMIMONTHLY = "semimonthly"
    """Resource is updated twice monthly."""

    BIENNIALLY = "biennially"
    """Resource is updated every two years."""

ANNUALLY = 'annually' class-attribute instance-attribute

Resource is updated every year.

AS_NEEDED = 'asNeeded' class-attribute instance-attribute

Resource is updated as deemed necessary.

BIANNUALLY = 'biannually' class-attribute instance-attribute

Resource is updated twice each year.

BIENNIALLY = 'biennially' class-attribute instance-attribute

Resource is updated every two years.

CONTINUAL = 'continual' class-attribute instance-attribute

Resource is repeatedly and frequentlyupdated.

DAILY = 'daily' class-attribute instance-attribute

Resource is updated each day

FORTNIGHTLY = 'fortnightly' class-attribute instance-attribute

Resource is updated every two weeks.

IRREGULAR = 'irregular' class-attribute instance-attribute

Resource is updated in intervals that are uneven in duration.

MONTHLY = 'monthly' class-attribute instance-attribute

Resource is updated each month.

NOT_PLANNED = 'notPlanned' class-attribute instance-attribute

There are no plans to update the data.

PERIODIC = 'periodic' class-attribute instance-attribute

Resource is updated at regular intervals.

QUARTERLY = 'quarterly' class-attribute instance-attribute

Resource is updatedevery three months.

SEMIMONTHLY = 'semimonthly' class-attribute instance-attribute

Resource is updated twice monthly.

UNKNOWN = 'unknown' class-attribute instance-attribute

Frequency of maintenance for the data is not known.

WEEKLY = 'weekly' class-attribute instance-attribute

Resource is updated on a weekly basis.

MaintenanceInformation

Bases: ABC

Information about the scope and frequency of updating.

Source code in opengis/metadata/maintenance.py 
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
class MaintenanceInformation(ABC):
    """Information about the scope and frequency of updating."""

    @property
    @abstractmethod
    def maintenance_and_update_frequency(self) -> Optional[
        MaintenanceFrequencyCode
    ]:
        """
        Frequency with which changes and additions are made to the resource
        after the initial resource is completed.

        MANDATORY: if `user_defined_maintenance_frequency` is `None`.
        """

    @property
    @abstractmethod
    def maintenance_date(self) -> Optional[Sequence[Date]]:
        """Date information associated with maintenance of resource."""

    @property
    @abstractmethod
    def user_defined_maintenance_frequency(self) -> Optional[timedelta]:
        """
        Maintenance period other than those defined.

        MANDATORY: if `user_defined_maintenance_frequency` is `None`.
        """

    @property
    @abstractmethod
    def maintenance_scope(self) -> Optional[Sequence[Scope]]:
        """Information about the scope and extent of maintenance."""

    @property
    @abstractmethod
    def maintenance_note(self) -> Optional[Sequence[str]]:
        """
        Information regarding specific requirements for maintaining the
        resource.
        """

    @property
    @abstractmethod
    def contact(self) -> Optional[Sequence[Responsibility]]:
        """
        Identification of, and means of communicating with, person(s) and
        organisation(s) with responsibility for maintaining the metadata.
        """

contact: Optional[Sequence[Responsibility]] abstractmethod property

Identification of, and means of communicating with, person(s) and organisation(s) with responsibility for maintaining the metadata.

maintenance_and_update_frequency: Optional[MaintenanceFrequencyCode] abstractmethod property

Frequency with which changes and additions are made to the resource after the initial resource is completed.

MANDATORY: if user_defined_maintenance_frequency is None.

maintenance_date: Optional[Sequence[Date]] abstractmethod property

Date information associated with maintenance of resource.

maintenance_note: Optional[Sequence[str]] abstractmethod property

Information regarding specific requirements for maintaining the resource.

maintenance_scope: Optional[Sequence[Scope]] abstractmethod property

Information about the scope and extent of maintenance.

user_defined_maintenance_frequency: Optional[timedelta] abstractmethod property

Maintenance period other than those defined.

MANDATORY: if user_defined_maintenance_frequency is None.

Scope

Bases: ABC

The target resource and physical extent for which information is reported. Information about the scope of the resource.

Source code in opengis/metadata/maintenance.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
class Scope(ABC):
    """
    The target resource and physical extent for which information is reported.
    Information about the scope of the resource.
    """

    @property
    @abstractmethod
    def level(self) -> ScopeCode:
        """Description of the scope."""

    @property
    @abstractmethod
    def extent(self) -> Optional[Sequence[Extent]]:
        """
        Information about the horizontal, vertical, and temporal extent of
        the specified resource.
        """

    @property
    @abstractmethod
    def level_description(self) -> Optional[Sequence[ScopeDescription]]:
        """
        Detailed information/listing of the items specified by the level.
        """

extent: Optional[Sequence[Extent]] abstractmethod property

Information about the horizontal, vertical, and temporal extent of the specified resource.

level: ScopeCode abstractmethod property

Description of the scope.

level_description: Optional[Sequence[ScopeDescription]] abstractmethod property

Detailed information/listing of the items specified by the level.

ScopeCode

Bases: Enum

Class of information to which the referencing entity applies.

Source code in opengis/metadata/maintenance.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class ScopeCode(Enum):
    """Class of information to which the referencing entity applies."""

    ATTRIBUTE = "attribute"
    """Information applies to the attribute value."""

    ATTRIBUTE_TYPE = "attributeType"
    """Information applies to the characteristic of a feature."""

    COLLECTION_HARDWARE = "collectionHardware"
    """Information applies to the collection hardware class."""

    COLLECTION_SESSION = "collectionSession"
    """Information applies to the collection session."""

    DATASET = "dataset"
    """Information applies to the dataset."""

    SERIES = "series"
    """Information applies to the series."""

    NON_GEOGRAPHIC_DATASET = "nonGeographicDataset"
    """Information applies to the non-geographic dataset."""

    DIMENSION_GROUP = "dimensionGroup"
    """Information applies to a dimension group."""

    FEATURE = "feature"
    """Information applies to a featiure."""

    FEATURE_TYPE = "featureType"
    """Information applies to a feature type."""

    PROPERTY_TYPE = "propertyType"
    """Information applies to a property type."""

    FIELD_SESSION = "fieldSession"
    """Information applies to a field session."""

    SOFTWARE = "software"
    """Information applies to a computer program or routine."""

    SERVICE = "service"
    """
    Information applies to a capability which a service provider entity makes
    available to s service user entity through a set of interfaces that define
    a behaviour, such as a use case.
    """

    MODEL = "model"
    """
    Information applies to a copy or imitation of an existing or hypothetical
    object.
    """

    TILE = "tile"
    """Information applies to a tile, a spatial subset of geographic data."""

    METADATA = "metadata"
    """Information applies to metadata."""

    INITIATIVE = "initiative"
    """Information applies to an intitiative."""

    SAMPLE = "sample"
    """Information applies to a sample."""

    DOCUMENT = "document"
    """Information applies to a document."""

    REPOSITORY = "repository"
    """Information applies to a repository."""

    AGGREGATE = "aggregate"
    """Information applies to an aggregate resource."""

    PRODUCT = "product"
    """Metadata describing an ISO 19131 data product specification."""

    COLLECTION = "collection"
    """Information applies to an unstructured set."""

    COVERAGE = "coverage"
    """Information applies to a coverage."""

    APPLICATION = "application"
    """
    Information resource hosted on a specific set of hardware and accessible
    over a network.
    """

AGGREGATE = 'aggregate' class-attribute instance-attribute

Information applies to an aggregate resource.

APPLICATION = 'application' class-attribute instance-attribute

Information resource hosted on a specific set of hardware and accessible over a network.

ATTRIBUTE = 'attribute' class-attribute instance-attribute

Information applies to the attribute value.

ATTRIBUTE_TYPE = 'attributeType' class-attribute instance-attribute

Information applies to the characteristic of a feature.

COLLECTION = 'collection' class-attribute instance-attribute

Information applies to an unstructured set.

COLLECTION_HARDWARE = 'collectionHardware' class-attribute instance-attribute

Information applies to the collection hardware class.

COLLECTION_SESSION = 'collectionSession' class-attribute instance-attribute

Information applies to the collection session.

COVERAGE = 'coverage' class-attribute instance-attribute

Information applies to a coverage.

DATASET = 'dataset' class-attribute instance-attribute

Information applies to the dataset.

DIMENSION_GROUP = 'dimensionGroup' class-attribute instance-attribute

Information applies to a dimension group.

DOCUMENT = 'document' class-attribute instance-attribute

Information applies to a document.

FEATURE = 'feature' class-attribute instance-attribute

Information applies to a featiure.

FEATURE_TYPE = 'featureType' class-attribute instance-attribute

Information applies to a feature type.

FIELD_SESSION = 'fieldSession' class-attribute instance-attribute

Information applies to a field session.

INITIATIVE = 'initiative' class-attribute instance-attribute

Information applies to an intitiative.

METADATA = 'metadata' class-attribute instance-attribute

Information applies to metadata.

MODEL = 'model' class-attribute instance-attribute

Information applies to a copy or imitation of an existing or hypothetical object.

NON_GEOGRAPHIC_DATASET = 'nonGeographicDataset' class-attribute instance-attribute

Information applies to the non-geographic dataset.

PRODUCT = 'product' class-attribute instance-attribute

Metadata describing an ISO 19131 data product specification.

PROPERTY_TYPE = 'propertyType' class-attribute instance-attribute

Information applies to a property type.

REPOSITORY = 'repository' class-attribute instance-attribute

Information applies to a repository.

SAMPLE = 'sample' class-attribute instance-attribute

Information applies to a sample.

SERIES = 'series' class-attribute instance-attribute

Information applies to the series.

SERVICE = 'service' class-attribute instance-attribute

Information applies to a capability which a service provider entity makes available to s service user entity through a set of interfaces that define a behaviour, such as a use case.

SOFTWARE = 'software' class-attribute instance-attribute

Information applies to a computer program or routine.

TILE = 'tile' class-attribute instance-attribute

Information applies to a tile, a spatial subset of geographic data.

ScopeDescription

Bases: ABC

Description of the class of information covered by the information.

Source code in opengis/metadata/maintenance.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
class ScopeDescription(ABC):
    """Description of the class of information covered by the information."""

    @property
    @abstractmethod
    def attributes(self) -> Optional[Set[str]]:
        """
        Instances of attribute types to which the information applies.

        MANDATORY: if `features`, `feature_instances`, `attribute_instances`,
            `dataset`, and `other` are `None`.
        """

    @property
    @abstractmethod
    def features(self) -> Optional[Set[str]]:
        """
        Instances of feature types to which the information applies.

        MANDATORY: if `attributes`, `feature_instances`, `attribute_instances`,
            `dataset`, and `other` are `None`.
        """

    @property
    @abstractmethod
    def feature_instances(self) -> Optional[Set[str]]:
        """
        Feature instances to which the information applies.

        MANDATORY: if `attributes`, `features`, `attribute_instances`,
            `dataset`, and `other` are `None`.
        """

    @property
    @abstractmethod
    def attribute_instances(self) -> Optional[Set[str]]:
        """
        Attribute instances to which the information applies.

        MANDATORY: if `attributes`, `features`, `feature_instances`,
            `dataset`, and `other` are `None`.
        """

    @property
    @abstractmethod
    def dataset(self) -> Optional[str]:
        """
        Dataset to which the information applies.

        MANDATORY: if `attributes`, `features`, `feature_instances`,
            `attribute_instances`, and `other` are `None`.
        """

    @property
    @abstractmethod
    def other(self) -> Optional[str]:
        """
        Class of information that does not fall into the other categories to
        which the information applies.

        MANDATORY: if `attributes`, `features`, `feature_instances`,
            `attribute_instances`, and `dataset` are `None`.
        """

attribute_instances: Optional[Set[str]] abstractmethod property

Attribute instances to which the information applies.

if attributes, features, feature_instances,

dataset, and other are None.

attributes: Optional[Set[str]] abstractmethod property

Instances of attribute types to which the information applies.

if features, feature_instances, attribute_instances,

dataset, and other are None.

dataset: Optional[str] abstractmethod property

Dataset to which the information applies.

if attributes, features, feature_instances,

attribute_instances, and other are None.

feature_instances: Optional[Set[str]] abstractmethod property

Feature instances to which the information applies.

if attributes, features, attribute_instances,

dataset, and other are None.

features: Optional[Set[str]] abstractmethod property

Instances of feature types to which the information applies.

if attributes, feature_instances, attribute_instances,

dataset, and other are None.

other: Optional[str] abstractmethod property

Class of information that does not fall into the other categories to which the information applies.

if attributes, features, feature_instances,

attribute_instances, and dataset are None.