QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsLayerMetadataProviderResult Class Reference

Result record of layer metadata provider search. More...

#include <qgsabstractlayermetadataprovider.h>

Inheritance diagram for QgsLayerMetadataProviderResult:
Inheritance graph
[legend]

Public Member Functions

 QgsLayerMetadataProviderResult ()=default
 Default constructor. More...
 
 QgsLayerMetadataProviderResult (const QgsLayerMetadata &metadata)
 Constructor for QgsLayerMetadataProviderResult. More...
 
const QString & authid () const
 Returns the layer CRS authid. More...
 
const QString & dataProviderName () const
 Returns the data provider name. More...
 
const QgsPolygongeographicExtent () const
 Returns the layer extent in EPSG:4326. More...
 
const QgsWkbTypes::GeometryTypegeometryType () const
 Returns the layer geometry type. More...
 
QgsMapLayerType layerType () const
 Returns the layer type. More...
 
void setAuthid (const QString &authid)
 Sets the layer authid. More...
 
void setDataProviderName (const QString &dataProviderName)
 Sets the data provider name to dataProviderName. More...
 
void setGeographicExtent (const QgsPolygon &geographicExtent)
 Sets the layer extent in EPSG:4326 to geographicExtent. More...
 
void setGeometryType (const QgsWkbTypes::GeometryType &geometryType)
 Sets the layer geometry type to geometryType. More...
 
void setLayerType (QgsMapLayerType layerType)
 Sets the layer type to layerType. More...
 
void setStandardUri (const QString &standardUri)
 Sets the metadata standard URI to standardUri. More...
 
void setUri (const QString &Uri)
 Sets the layer data source URI to Uri. More...
 
const QString & standardUri () const
 Returns the metadata standard URI (usually "http://mrcc.com/qgis.dtd") More...
 
const QString & uri () const
 Returns the layer data source URI. More...
 
- Public Member Functions inherited from QgsAbstractMetadataBase
virtual ~QgsAbstractMetadataBase ()=default
 
QString abstract () const
 Returns a free-form description of the resource. More...
 
void addContact (const QgsAbstractMetadataBase::Contact &contact)
 Adds an individual contact to the existing contacts. More...
 
void addHistoryItem (const QString &text)
 Adds a single history text to the end of the existing history list. More...
 
void addKeywords (const QString &vocabulary, const QStringList &keywords)
 Adds a list of descriptive keywords for a specified vocabulary. More...
 
void addLink (const QgsAbstractMetadataBase::Link &link)
 Adds an individual link to the existing links. More...
 
QStringList categories () const
 Returns categories of the resource. More...
 
virtual QgsAbstractMetadataBaseclone () const =0
 Clones the metadata object. More...
 
virtual void combine (const QgsAbstractMetadataBase *other)
 Combines the metadata from this object with the metadata from an other object. More...
 
QgsAbstractMetadataBase::ContactList contacts () const
 Returns a list of contact persons or entities associated with the resource. More...
 
QDateTime dateTime (Qgis::MetadataDateType type) const
 Returns the date for the specified date type. More...
 
QStringList history () const
 Returns a freeform description of the history or lineage of the resource. More...
 
QString identifier () const
 A reference, URI, URL or some other mechanism to identify the resource. More...
 
QgsAbstractMetadataBase::KeywordMap keywords () const
 Returns the keywords map, which is a set of descriptive keywords associated with the resource. More...
 
QStringList keywords (const QString &vocabulary) const
 Returns a list of keywords for the specified vocabulary. More...
 
QStringList keywordVocabularies () const
 Returns a list of keyword vocabularies contained in the metadata. More...
 
QString language () const
 Returns the human language associated with the resource. More...
 
QgsAbstractMetadataBase::LinkList links () const
 Returns a list of online resources associated with the resource. More...
 
QString parentIdentifier () const
 A reference, URI, URL or some other mechanism to identify the parent resource that this resource is a part (child) of. More...
 
virtual bool readMetadataXml (const QDomElement &metadataElement)
 Sets state from DOM document. More...
 
bool removeKeywords (const QString &vocabulary)
 Remove a vocabulary from the list. More...
 
void setAbstract (const QString &abstract)
 Sets a free-form abstract (description) of the resource. More...
 
void setCategories (const QStringList &categories)
 Sets categories of the resource. More...
 
void setContacts (const QgsAbstractMetadataBase::ContactList &contacts)
 Sets the list of contacts or entities associated with the resource. More...
 
void setDateTime (Qgis::MetadataDateType type, QDateTime date)
 Sets a date value for the specified date type. More...
 
void setHistory (const QStringList &history)
 Sets the freeform description of the history or lineage of the resource. More...
 
void setIdentifier (const QString &identifier)
 Sets the reference, URI, URL or some other mechanism to identify the resource. More...
 
void setKeywords (const QgsAbstractMetadataBase::KeywordMap &keywords)
 Sets the keywords map, which is a set of descriptive keywords associated with the resource. More...
 
void setLanguage (const QString &language)
 Sets the human language associated with the resource. More...
 
void setLinks (const QgsAbstractMetadataBase::LinkList &links)
 Sets the list of online resources associated with the resource. More...
 
void setParentIdentifier (const QString &parentIdentifier)
 Sets a reference, URI, URL or some other mechanism to identify the parent resource that this resource is a part (child) of. More...
 
void setTitle (const QString &title)
 Sets the human readable title (name) of the resource, typically displayed in search results. More...
 
void setType (const QString &type)
 Sets the type (nature) of the resource. More...
 
QString title () const
 Returns the human readable name of the resource, typically displayed in search results. More...
 
QString type () const
 Returns the nature of the resource. More...
 
virtual bool writeMetadataXml (QDomElement &metadataElement, QDomDocument &document) const
 Stores state in a DOM node. More...
 

Additional Inherited Members

- Public Types inherited from QgsAbstractMetadataBase
typedef QList< QgsAbstractMetadataBase::ContactContactList
 A list of contacts. More...
 
typedef QMap< QString, QStringList > KeywordMap
 Map of vocabulary string to keyword list. More...
 
typedef QList< QgsAbstractMetadataBase::LinkLinkList
 A list of links. More...
 
- Protected Member Functions inherited from QgsAbstractMetadataBase
 QgsAbstractMetadataBase ()=default
 Constructor for QgsAbstractMetadataBase. More...
 
bool equals (const QgsAbstractMetadataBase &other) const
 Tests whether the common metadata fields in this object are equal to other. More...
 
- Protected Attributes inherited from QgsAbstractMetadataBase
QString mAbstract
 
QgsAbstractMetadataBase::ContactList mContacts
 
QMap< Qgis::MetadataDateType, QDateTime > mDates
 Metadata dates. More...
 
QStringList mHistory
 
QString mIdentifier
 
QgsAbstractMetadataBase::KeywordMap mKeywords
 Keywords map. More...
 
QString mLanguage
 
QgsAbstractMetadataBase::LinkList mLinks
 
QString mParentIdentifier
 
QString mTitle
 
QString mType
 

Detailed Description

Result record of layer metadata provider search.

The result contains QGIS metadata information and all information that is required by QGIS to load the layer and to filter the results.

The class extends QgsLayerMetadata by adding information taken directly from the provider which is required for filtering (geographic extent) or because the actual values may be different by those stored in the metadata (CRS authid) or totally missing from the metadata (data provider name and layer type).

Since
QGIS 3.28

Definition at line 59 of file qgsabstractlayermetadataprovider.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataProviderResult() [1/2]

QgsLayerMetadataProviderResult::QgsLayerMetadataProviderResult ( const QgsLayerMetadata metadata)

Constructor for QgsLayerMetadataProviderResult.

Parameters
metadatalayer metadata.

Definition at line 43 of file qgsabstractlayermetadataprovider.cpp.

◆ QgsLayerMetadataProviderResult() [2/2]

QgsLayerMetadataProviderResult::QgsLayerMetadataProviderResult ( )
default

Default constructor.

Member Function Documentation

◆ authid()

const QString & QgsLayerMetadataProviderResult::authid ( ) const

Returns the layer CRS authid.

Definition at line 69 of file qgsabstractlayermetadataprovider.cpp.

◆ dataProviderName()

const QString & QgsLayerMetadataProviderResult::dataProviderName ( ) const

Returns the data provider name.

Definition at line 89 of file qgsabstractlayermetadataprovider.cpp.

◆ geographicExtent()

const QgsPolygon & QgsLayerMetadataProviderResult::geographicExtent ( ) const

Returns the layer extent in EPSG:4326.

Definition at line 49 of file qgsabstractlayermetadataprovider.cpp.

◆ geometryType()

const QgsWkbTypes::GeometryType & QgsLayerMetadataProviderResult::geometryType ( ) const

Returns the layer geometry type.

Definition at line 59 of file qgsabstractlayermetadataprovider.cpp.

◆ layerType()

QgsMapLayerType QgsLayerMetadataProviderResult::layerType ( ) const

Returns the layer type.

Definition at line 99 of file qgsabstractlayermetadataprovider.cpp.

◆ setAuthid()

void QgsLayerMetadataProviderResult::setAuthid ( const QString &  authid)

Sets the layer authid.

Definition at line 74 of file qgsabstractlayermetadataprovider.cpp.

◆ setDataProviderName()

void QgsLayerMetadataProviderResult::setDataProviderName ( const QString &  dataProviderName)

Sets the data provider name to dataProviderName.

Definition at line 94 of file qgsabstractlayermetadataprovider.cpp.

◆ setGeographicExtent()

void QgsLayerMetadataProviderResult::setGeographicExtent ( const QgsPolygon geographicExtent)

Sets the layer extent in EPSG:4326 to geographicExtent.

Definition at line 54 of file qgsabstractlayermetadataprovider.cpp.

◆ setGeometryType()

void QgsLayerMetadataProviderResult::setGeometryType ( const QgsWkbTypes::GeometryType geometryType)

Sets the layer geometry type to geometryType.

Definition at line 64 of file qgsabstractlayermetadataprovider.cpp.

◆ setLayerType()

void QgsLayerMetadataProviderResult::setLayerType ( QgsMapLayerType  layerType)

Sets the layer type to layerType.

Definition at line 104 of file qgsabstractlayermetadataprovider.cpp.

◆ setStandardUri()

void QgsLayerMetadataProviderResult::setStandardUri ( const QString &  standardUri)

Sets the metadata standard URI to standardUri.

Definition at line 114 of file qgsabstractlayermetadataprovider.cpp.

◆ setUri()

void QgsLayerMetadataProviderResult::setUri ( const QString &  Uri)

Sets the layer data source URI to Uri.

Definition at line 84 of file qgsabstractlayermetadataprovider.cpp.

◆ standardUri()

const QString & QgsLayerMetadataProviderResult::standardUri ( ) const

Returns the metadata standard URI (usually "http://mrcc.com/qgis.dtd")

Definition at line 109 of file qgsabstractlayermetadataprovider.cpp.

◆ uri()

const QString & QgsLayerMetadataProviderResult::uri ( ) const

Returns the layer data source URI.

Definition at line 79 of file qgsabstractlayermetadataprovider.cpp.


The documentation for this class was generated from the following files: