Part of elisa.plugins.search.searcher View In Hierarchy
Known subclasses: elisa.plugins.database.searcher.DBSearcher, elisa.plugins.search.tests.test_search_metaresource.BitterSearcher, elisa.plugins.search.tests.test_search_metaresource.DummySearcher, elisa.plugins.search.tests.test_search_metaresource.HangingSearcher, elisa.plugins.yesfm.searcher.YesfmSearcher
A searcher is a glue object. It knows how to do a search request for a certain API and how to wrap the result into the SearchResultModel.
A searcher is a sub component of the elisa.plugins.search.search_metaresource_provider.SearchMetaresourceProvider
.
It is loaded from the specified entry point and the hold by the
provider.
Class Variables | paths | the different paths this searcher knows how to handle. For example:
'music', 'pictures'
(type: list of str
) |
provider_path | the path to the provider this searcher is for
(type: str
) |
Line # | Kind | Name | Docs |
---|---|---|---|
52 | Method | __init__ | Undocumented |
57 | Method | search | Trigger a search for uri and fill the
result_model with the
|
Inherited from Component:
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. |
uri
and fill the
result_model
with the results.
Parameters | uri | the original URI that was requested. See the corresponding documentation
in SearchMetaresource.get for more informations about it.
(type: elisa.core.media_uri.MediaUri
) |
result_model | containing the result for this search and should be filled
asynchronously in background
(type: one of elisa.plugins.search.result_models
) | |
Returns | fired whenever the search is done
(type: elisa.core.utils.cancellable_defer.CancellableDeferred
) |