-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsabstractmetadatabase.h
585 lines (496 loc) · 17.1 KB
/
qgsabstractmetadatabase.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
87
88
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
179
180
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
244
245
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
271
272
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/***************************************************************************
QgsAbstractMetadataBase.h
-------------------
begin : March 2018
copyright : (C) 2018 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSABSTRACTMETADATABASE_H
#define QGSABSTRACTMETADATABASE_H
#include "qgis.h"
#include "qgis_core.h"
class QDomElement;
class QDomDocument;
/**
* \ingroup core
* \class QgsAbstractMetadataBase
* \brief An abstract base class for metadata stores.
*
* QgsAbstractMetadataBase is the base class for handling storage and management of the metadata
* for various map related assets. This class is an internal QGIS format with a common
* metadata structure. It is subclassed by layer and project specific metadata classes,
* such as QgsLayerMetadata and QgsProjectMetadata.
*
* The metadata store is designed to be compatible with the Dublin Core metadata
* specifications, and will be expanded to allow compatibility with ISO specifications
* in future releases. However, the QGIS internal schema does not represent a superset
* of all existing metadata schemas and accordingly conversion from specific
* metadata formats to QgsAbstractMetadataBase may result in a loss of information.
*
* This class is designed to follow the specifications detailed in
* the schema definition available at resources/qgis-base-metadata.xsd
* within the QGIS source code.
*
* Metadata can be validated through the use of QgsAbstractMetadataBaseValidator
* subclasses. E.g. validating against the native QGIS metadata schema can be performed
* using QgsNativeMetadataValidator.
*
* \since QGIS 3.2
*/
class CORE_EXPORT QgsAbstractMetadataBase
{
#ifdef SIP_RUN
SIP_CONVERT_TO_SUBCLASS_CODE
if ( dynamic_cast< QgsLayerMetadata * >( sipCpp ) != NULL )
sipType = sipType_QgsLayerMetadata;
else if ( dynamic_cast< QgsProjectMetadata * >( sipCpp ) != NULL )
sipType = sipType_QgsProjectMetadata;
else
sipType = NULL;
SIP_END
#endif
public:
// NOTE - these really belong in a separate namespace, but SIP says no, I want to make you waste more time
// TODO: dump sip
/**
* Map of vocabulary string to keyword list.
*/
typedef QMap< QString, QStringList > KeywordMap;
/**
* Metadata address structure.
* \ingroup core
* \since QGIS 3.2
*/
struct CORE_EXPORT Address
{
/**
* Constructor for Address.
*/
Address( const QString &type = QString(), const QString &address = QString(), const QString &city = QString(), const QString &administrativeArea = QString(), const QString &postalCode = QString(), const QString &country = QString() )
: type( type )
, address( address )
, city( city )
, administrativeArea( administrativeArea )
, postalCode( postalCode )
, country( country )
{}
/**
* Type of address, e.g. 'postal'.
*/
QString type;
/**
* Free-form physical address component, e.g. '221B Baker St' or 'P.O. Box 196'.
*/
QString address;
/**
* City or locality name.
*/
QString city;
/**
* Administrative area (state, province/territory, etc.).
*/
QString administrativeArea;
/**
* Postal (or ZIP) code.
*/
QString postalCode;
/**
* Free-form country string.
*/
QString country;
bool operator==( const QgsAbstractMetadataBase::Address &other ) const;
};
/**
* Metadata contact structure.
* \ingroup core
* \since QGIS 3.2
*/
struct CORE_EXPORT Contact
{
/**
* Constructor for Contact.
*/
Contact( const QString &name = QString() )
: name( name )
{}
/**
* Name of contact.
*/
QString name;
/**
* Organization contact belongs to/represents.
*/
QString organization;
/**
* Position/title of contact.
*/
QString position;
/**
* List of addresses associated with this contact.
*/
QList< QgsAbstractMetadataBase::Address > addresses;
/**
* Voice telephone.
*/
QString voice;
/**
* Facsimile telephone.
*/
QString fax;
/**
* Electronic mail address.
* \note Do not include mailto: protocol as part of the email address.
*/
QString email;
/**
* Role of contact. Acceptable values are those from the ISO 19115 CI_RoleCode specifications
* (see http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml).
* E.g. 'custodian', 'owner', 'distributor', etc.
*/
QString role;
bool operator==( const QgsAbstractMetadataBase::Contact &other ) const;
};
/**
* A list of contacts.
* \ingroup core
* \since QGIS 3.2
*/
typedef QList< QgsAbstractMetadataBase::Contact > ContactList;
/**
* Metadata link structure.
* \ingroup core
* \since QGIS 3.2
*/
struct CORE_EXPORT Link
{
/**
* Constructor for Link.
*/
Link( const QString &name = QString(), const QString &type = QString(), const QString &url = QString() )
: name( name )
, type( type )
, url( url )
{}
/**
* Short link name. E.g. WMS layer name.
*/
QString name;
/**
* Link type. It is strongly suggested to use values from the 'identifier'
* column in https://github.com/OSGeo/Cat-Interop/blob/master/LinkPropertyLookupTable.csv
*/
QString type;
/**
* Abstract text about link.
*/
QString description;
/**
* Link url. If the URL is an OWS server, specify the *base* URL only without parameters like service=xxx....
*/
QString url;
/**
* Format specification of online resource. It is strongly suggested to use GDAL/OGR format values.
*/
QString format;
/**
* MIME type representative of the online resource response (image/png, application/json, etc.)
*/
QString mimeType;
/**
* Estimated size (in bytes) of the online resource response.
*/
QString size;
bool operator==( const QgsAbstractMetadataBase::Link &other ) const;
};
/**
* A list of links.
* \ingroup core
* \since QGIS 3.2
*/
typedef QList< QgsAbstractMetadataBase::Link > LinkList;
virtual ~QgsAbstractMetadataBase() = default;
/**
* Clones the metadata object.
* \since QGIS 3.2
*/
virtual QgsAbstractMetadataBase *clone() const = 0 SIP_FACTORY;
/**
* A reference, URI, URL or some other mechanism to identify the resource.
* \see setIdentifier()
*/
QString identifier() const;
/**
* Sets the reference, URI, URL or some other mechanism to identify the resource.
* \see identifier()
*/
void setIdentifier( const QString &identifier );
/**
* A reference, URI, URL or some other mechanism to identify the parent resource that this resource is a part (child) of.
* Returns an empty string if no parent identifier is set.
* \see setParentIdentifier()
*/
QString parentIdentifier() const;
/**
* Sets a reference, URI, URL or some other mechanism to identify the parent resource that this resource is a part (child) of.
* Set an empty string if no parent identifier is required.
* \see parentIdentifier()
*/
void setParentIdentifier( const QString &parentIdentifier );
/**
* Returns the human language associated with the resource. Usually the returned string
* will follow either the ISO 639.2 or ISO 3166 specifications, e.g. 'ENG' or 'SPA', however
* this is not a hard requirement and the caller must account for non compliant
* values.
* \see setLanguage()
*/
QString language() const;
/**
* Sets the human \a language associated with the resource. While a formal vocabulary is not imposed,
* ideally values should be taken from the ISO 639.2 or ISO 3166 specifications,
* e.g. 'ENG' or 'SPA' (ISO 639.2) or 'EN-AU' (ISO 3166).
* \see language()
*/
void setLanguage( const QString &language );
/**
* Returns the nature of the resource. While a formal vocabulary is not imposed, it is advised
* to use the ISO 19115 MD_ScopeCode values. E.g. 'dataset' or 'series'.
* \see setType()
*/
QString type() const;
/**
* Sets the \a type (nature) of the resource. While a formal vocabulary is not imposed, it is advised
* to use the ISO 19115 MD_ScopeCode values. E.g. 'dataset' or 'series'.
* \see type()
*/
void setType( const QString &type );
/**
* Returns the human readable name of the resource, typically displayed in search results.
* \see setTitle()
*/
QString title() const;
/**
* Sets the human readable \a title (name) of the resource, typically displayed in search results.
* \see title()
*/
void setTitle( const QString &title );
/**
* Returns a free-form description of the resource.
* \see setAbstract()
*/
QString abstract() const;
/**
* Sets a free-form \a abstract (description) of the resource.
* \see abstract()
*/
void setAbstract( const QString &abstract );
/**
* Returns a freeform description of the history or lineage of the resource.
* \see setHistory()
*/
QStringList history() const;
/**
* Sets the freeform description of the \a history or lineage of the resource.
* Any existing history items will be overwritten.
* \see addHistoryItem()
* \see history()
*/
void setHistory( const QStringList &history );
/**
* Adds a single history \a text to the end of the existing history list.
* \see history()
* \see setHistory()
*/
void addHistoryItem( const QString &text );
/**
* Returns the keywords map, which is a set of descriptive keywords associated with the resource.
*
* The map key is the vocabulary string and map value is a list of keywords for that vocabulary.
*
* The vocabulary string is a reference (URI/URL preferred) to a codelist or vocabulary
* associated with keyword list.
*
* \see setKeywords()
* \see keywordVocabularies()
*/
QgsAbstractMetadataBase::KeywordMap keywords() const;
/**
* Sets the \a keywords map, which is a set of descriptive keywords associated with the resource.
*
* The map key is the vocabulary string and map value is a list of keywords for that vocabulary.
* Calling this replaces any existing keyword vocabularies.
*
* The vocabulary string is a reference (URI/URL preferred) to a codelist or vocabulary
* associated with keyword list.
*
* \see keywords()
* \see addKeywords()
*/
void setKeywords( const QgsAbstractMetadataBase::KeywordMap &keywords );
/**
* Adds a list of descriptive \a keywords for a specified \a vocabulary. Any existing
* keywords for the same vocabulary will be replaced. Other vocabularies
* will not be affected.
*
* The vocabulary string is a reference (URI/URL preferred) to a codelist or vocabulary
* associated with keyword list.
*
* \see setKeywords()
*/
void addKeywords( const QString &vocabulary, const QStringList &keywords );
/**
* Remove a vocabulary from the list.
*
* \see setKeywords()
* \see addKeywords()
*/
bool removeKeywords( const QString &vocabulary );
/**
* Returns a list of keyword vocabularies contained in the metadata.
*
* The vocabulary string is a reference (URI/URL preferred) to a codelist or vocabulary
* associated with keyword list.
*
* \see keywords()
*/
QStringList keywordVocabularies() const;
/**
* Returns a list of keywords for the specified \a vocabulary.
* If the vocabulary is not contained in the metadata, an empty
* list will be returned.
*
* The vocabulary string is a reference (URI/URL preferred) to a codelist or vocabulary
* associated with keyword list.
*
* \see keywordVocabularies()
*/
QStringList keywords( const QString &vocabulary ) const;
/**
* Returns categories of the resource.
* Categories are stored using a special vocabulary 'gmd:topicCategory' in keywords.
*
* \see keywords()
*/
QStringList categories() const;
/**
* Sets categories of the resource.
* Categories are stored using a special vocabulary 'gmd:topicCategory' in keywords.
*
* \see keywords()
*/
void setCategories( const QStringList &categories );
/**
* Returns a list of contact persons or entities associated with the resource.
* \see setContacts()
*/
QgsAbstractMetadataBase::ContactList contacts() const;
/**
* Sets the list of \a contacts or entities associated with the resource. Any existing contacts
* will be replaced.
* \see contacts()
* \see addContact()
*/
void setContacts( const QgsAbstractMetadataBase::ContactList &contacts );
/**
* Adds an individual \a contact to the existing contacts.
* \see contacts()
* \see setContacts()
*/
void addContact( const QgsAbstractMetadataBase::Contact &contact );
/**
* Returns a list of online resources associated with the resource.
* \see setLinks()
*/
QgsAbstractMetadataBase::LinkList links() const;
/**
* Sets the list of online resources associated with the resource. Any existing links
* will be replaced.
* \see links()
* \see addLink()
*/
void setLinks( const QgsAbstractMetadataBase::LinkList &links );
/**
* Adds an individual \a link to the existing links.
* \see links()
* \see setLinks()
*/
void addLink( const QgsAbstractMetadataBase::Link &link );
/**
* Sets state from DOM document.
*
* \param metadataElement The DOM element corresponding to ``resourceMetadata'' tag
*
* \returns true if successful
*
* Subclasses which override this method should take care to also call the base
* class method in order to read common metadata properties.
*/
virtual bool readMetadataXml( const QDomElement &metadataElement );
/**
* Stores state in a DOM node.
*
* \param metadataElement is a DOM element corresponding to ``resourceMetadata'' tag
* \param document is a the DOM document being written
*
* \returns true if successful
*
* Subclasses which override this method should take care to also call the base
* class method in order to write common metadata properties.
*/
virtual bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document ) const;
protected:
/**
* Constructor for QgsAbstractMetadataBase.
*
* QgsAbstractMetadataBase cannot be instantiated directly, it must be subclassed.
*/
QgsAbstractMetadataBase() = default;
/*
* IMPORTANT!!!!!!
*
* Do NOT add anything to this class without also updating the schema
* definition located at resources/qgis-resource-metadata.xsd
*
*/
QString mIdentifier;
QString mParentIdentifier;
QString mLanguage;
QString mType;
QString mTitle;
QString mAbstract;
QStringList mHistory;
// IMPORTANT - look up before adding anything here!!
/**
* Keywords map. Key is the vocabulary, value is a list of keywords for that vocabulary.
*/
QgsAbstractMetadataBase::KeywordMap mKeywords;
QgsAbstractMetadataBase::ContactList mContacts;
QgsAbstractMetadataBase::LinkList mLinks;
/*
* IMPORTANT!!!!!!
*
* Do NOT add anything to this class without also updating the schema
* definition located at resources/qgis-resource-metadata.xsd
*
*/
/**
* Tests whether the common metadata fields in this object are equal to \a other.
*
* Subclasses should utilize this method from their equality operators to test
* equality of base class members.
*
* \since QGIS 3.2
*/
bool equals( const QgsAbstractMetadataBase &other ) const;
};
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::KeywordMap )
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::ContactList )
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::LinkList )
#endif // QGSABSTRACTMETADATABASE_H