Class e.c.c.m.MetadataCapability(Capability):

Part of elisa.core.components.metadata_capability View In Hierarchy

Known subclasses: elisa.core.tests.test_metadata_manager.FlexibleMeta, elisa.plugins.amazon.metadata.AmazonCovers, elisa.plugins.tutorials.amazon.metadata.AmazonCovers

A metadata capability is a special type of capability that provides metadata retrieval services on top of a given resource provider.

For example, this could be a music album cover retriever built on top of the Amazon resource provider.

A metadata capability has a rank that determines the level of confidence the metadata manager should give it when retrieving metadata. It allows to give a capability a higher priority over another one.

Class Variablesrankthe rank of the capability for the metadata manager (type: positive int )
Line # Kind Name Docs
51 Method able_to_handle Test whether the capability is able to handle a metadata request on the
65 Method get_metadata Try to retrieve metadata and populate the model with it.

Inherited from Component (via Capability):

Line # Kind Name Docs
85 Class PathDescriptor Undocumented
97 Class Method create Create and initialize the component.
130 Method initialize Initialize the component.
142 Method clean Clean the component.

Inherited from Loggable (via Capability, Component):

Line # Kind Name Docs
81 Method __init__ Undocumented
def able_to_handle(self, model):
Test whether the capability is able to handle a metadata request on the given model.
Parametersmodelthe model for which metadata is requested (type: a subclass of elisa.core.components.model.Model )
ReturnsTrue if the capability is able to handle the given model, False otherwise (type: bool )
def get_metadata(self, model):
Try to retrieve metadata and populate the model with it.
Parametersmodelthe model that should be populated with the metadata (type: a subclass of elisa.core.components.model.Model )
Returnsa deferred fired when the metadata retrieval is complete (type: twisted.internet.defer.Deferred )
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.