avid.linkers.keyValueLinker.KeyValueLinker

class avid.linkers.keyValueLinker.KeyValueLinker(key, allowOnlyFullLinkage=True, performInternalLinkage=False)

Links data based on the value of a given key.

__init__(key, allowOnlyFullLinkage=True, performInternalLinkage=False): @param key The key of the artefacts that should be used to compare the values. For details of the other paramerter, see base class.

Methods

`__init__`(key[, allowOnlyFullLinkage, ...])	@param key The key of the artefacts that should be used to compare the values.
`getLinkedSelection`(primaryIndex, ...)	Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index.

getLinkedSelection(primaryIndex, primarySelections, secondarySelections): Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index. To change the behavior reimplement self._getLinkedSelection(). The default implementation just passes through the secondarySelections (so everything gets linked). Linker might alter a secondary selections before they are passed back as linked selections (e.g. change the order of the artefact in the selection or its content) @result List of all valid selections (list) of linked artefacts. Therefore all selections of artefacts from secondarySelections that fullfill the link criterion in respect to the primary selection. @param primaryIndex index of the entry in the primarySelections that is defining for the link. @param primarySelections the list of all selections that contain sets of primary artefacts @param secondarySelections the list that is used to generate/pick the linked selections from.