Class: QgsAbstractMetadataBaseValidator

Abstract base class for metadata validators.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: validate()

Class Hierarchy

Subclasses

QgsNativeMetadataBaseValidator

A validator for the native base QGIS metadata schema definition.

Abstract Methods

validate

Validates a metadata object, and returns True if the metadata is considered valid.

class qgis.core.QgsAbstractMetadataBaseValidator

Bases: object

class ValidationResult

Bases: object

Contains the parameters describing a metadata validation failure.

QgsAbstractMetadataBaseValidator.ValidationResult(section: Optional[str], note: Optional[str], identifier: Any = None) Constructor for ValidationResult.

QgsAbstractMetadataBaseValidator.ValidationResult(a0: QgsAbstractMetadataBaseValidator.ValidationResult)

property identifier

Returns the optional identifier for the failed metadata item. For instance, in list type metadata elements this will be set to the list index of the failed metadata item.

Return type:

Any

note: str

The reason behind the validation failure.

section: str

Metadata section which failed the validation

setIdentifier(self, identifier: Any)

Sets the optional identifier for the failed metadata item. For instance, in list type metadata elements this will be set to the list index of the failed metadata item.

Parameters:

identifier (Any)

abstract validate(self, metadata: QgsAbstractMetadataBase | None)

Validates a metadata object, and returns True if the metadata is considered valid. If validation fails, the results list will be filled with a list of items describing why the validation failed and what needs to be rectified to fix the metadata.

Parameters:

metadata (Optional[QgsAbstractMetadataBase]) -> (bool)