metadata module

Module metadata aims to define common interface about metadata mostly SBSMetaDataObject, SBSMetaDataTree, SBSMetaDataTreeType, SBSMetaDataTreeStr, and SBSMetaDataTreeUrl.

class common_interfaces.metadata.SBSMetaDataObject(aMetaDataTree=None)

Bases: object

Base class used to provide a MetaData common interface.

Members:

mMetaDataTree: List of metadata of type Url SBSMetaDataTree

createMetaDataStr(aName, aValue)

Create a metadata of type Str.

Parameters:

aName (str)
aResource (SBSResource object)

Returns:

A SBSMetaDataUrl object

createMetaDataUrl(aName, aResource)

Create a metadata of type Url.

Parameters:

aName (str)
aResource (SBSResource object)

Returns:

A SBSMetaDataUrl object

deleteMetaData(aName)

Delete a metadata, return True if success.

Parameters:: aName (str)
Returns:: bool

getAllMetaData()

Get all MetaData under dictionary form.

Returns:: dict

getMetaData(aName)

Get a MetaData by its name

Parameters:: aName (str)
Returns:: SBSMetaDataTreeUrl or SBSMetaDataTreeStr

getSBSMetaDataTree()

Get the SBSMetaDataTree structure.

Returns:: class .SBSMetaDataTree

setMetaDataName(aMetadata, aName)

Set name of a metadata if name is valid

Parameters:

aMetadata (SBSMetaDataTreeStr or SBSMetaDataTreeUrl) – a metadata SBSMetaDataTreeStr or SBSMetaDataTreeUrl object
aName (str) – a name/key for the metadata

setMetaDataValue(aMetadata, aValue)

Set value of a metadata

Parameters:

aMetadata (SBSMetaDataTreeStr or SBSMetaDataTreeUrl) – a metadata SBSMetaDataTreeStr or SBSMetaDataTreeUrl object
aValue (str) – a value for the metadata

class common_interfaces.metadata.SBSMetaDataTree(aMetaDataTreeUrlList=None, aMetaDataTreeStrList=None)

Bases: object

Class used to provide a MetaData common interface.

Members:

mMetaDataTreeUrlList: List of metadata of type Url SBSMetaDataTreeUrl
mMetaDataTreeStrList: List of metadata of type Str SBSMetaDataTreeStr

classmethod fromJson(aJsonData)

Classmethod to build a SBSMetaDataTree from the old json file. Here to support old package without xmp

Parameters:: aJsonData – a json dict
Returns:: SBSMetaDataTree

classmethod fromXmpIter(aMetaDataIter)

Classmethod to build a SBSMetaDataTree from a xmp SBSMetaDataIter

Parameters:: aMetaDataIter – a xmp SBSMetaDataIter
Returns:: SBSMetaDataTree

parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)

write(aSBSWriter, aXmlNode)

class common_interfaces.metadata.SBSMetaDataTreeStr(aName='', aValue='')

Bases: SBSMetaDataTreeType

Class used to defined the MetaData Str type.

property name

parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)

setName(**kwargs)

setValue(aValue): Setter exist to keep the original design of pysbs :param aValue: :return:

property value

write(aSBSWriter, aXmlNode)

class common_interfaces.metadata.SBSMetaDataTreeType(aName='', aValue='')

Bases: object

Base Class used to provide a common MetaData edition interface.

Members:

mName: the name type

property name

parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)

setName(**kwargs)

setValue(aValue): Setter exist to keep the original design of pysbs :param aValue: :return:

property value

write(aSBSWriter, aXmlNode)

class common_interfaces.metadata.SBSMetaDataTreeUrl(aName='', aValue='')

Bases: SBSMetaDataTreeType

Class used to defined the MetaData Url type.

property name

parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)

setName(**kwargs)

setValue(aResource): Setter exist to keep the original design of pysbs :param aValue: :return:

property value

write(aSBSWriter, aXmlNode)