vrdMetadata

class vrdMetadata

(Inherits vrdObject)

This class gives access to the metadata of an object.

Metadata is organized in metadata sets (vrdMetadataSet) which contain metadata entries (vrdMetadataEntry).

Metadata entries are either assigned to an object directly (those entries are bundled in the so called object set), or stored in shareable metadata sets that can be assigned to multiple objects.

Summary

Functions:

• entryCount() → integer
• getObjectSet() → vrdMetadataSet
• getSets() → List[vrdMetadataSet]
• getTags() → List[string]
• getValue(key) → QVariant
• hasKey(key) → bool
• hasObjectEntries() → bool
• hasSet(name) → bool
• hasType(type) → bool
• hasValue(value) → bool

Functions

vrdMetadata.entryCount()

Gets the count of all assigned metadata entries.

Returns:The count of all assigned metadata entries. Return type:integer

vrdMetadata.getObjectSet()

Gets the object set if an object set exists. If not, creates an object set.

Returns:A metadata set which contains all entries assigned to only this object. Return type:vrdMetadataSet

vrdMetadata.getSets()

Returns:Gets a list of all metadata sets assigned to the referenced object. The object set is not part of this list. Return type:List[vrdMetadataSet]

vrdMetadata.getTags()

Returns:A list of names of all assigned metadata entries of type Tag (vrMetadataTypes.ValueType.Tag). Return type:List[string]

vrdMetadata.getValue(key)

Gets the value of a specific key. If the key does not exist, a null variant is returned. If the key exists multiple times, it is undefined which one is returned.

Parameters:key (string) – The key we are looking for. Returns:The value of a specific key. Return type:QVariant

vrdMetadata.hasKey(key)

Parameters:key (string) – The key of an entry. Returns:True, if the object has an entry with the given key Return type:bool

vrdMetadata.hasObjectEntries()

Returns:True, if this object has an object set with entries. Return type:bool

vrdMetadata.hasSet(name)

Parameters:name (string) – The metadata set name we are looking for. Returns:True, if the object has a metadata set with the given name Return type:bool

vrdMetadata.hasType(type)

Parameters:type (vrMetadataTypes.ValueType) – The value type of an entry. Returns:True, if the object has an entry with the value type Return type:bool

vrdMetadata.hasValue(value)

Parameters:value (QVariant) – The value of an entry. Returns:True, if the object has an entry with the given value Return type:bool