Feature request: Extend AbstractSearchProcessor#postSearch(...) of the org.eclipse.help.searchProcessor extension point
#1725
Conversation
howlger
force-pushed
the
patch-searchProcessor
branch
from
c74b88b to
a202f0c
Compare
|
@iloveeclipse This is a work for Advantest and may be helpful for others too. |
Test Results 1 758 files + 3 1 758 suites +3 1h 33m 24s ⏱️ +55s For more details on these failures, see this check. Results for commit 1a7c801. ± Comparison against base commit 87a5e5a. ♻️ This comment has been updated with latest results. |
|
The code looks OK, but ideally we would have new test for the new API call. Could you please check if there are any related tests that could be updated in |
Yes, valid point. I will add some tests for the extended API (by extending or doing something similar to |
ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/federated/LocalHelp.java
Show resolved
Hide resolved
ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/SearchData.java
Show resolved
Hide resolved
ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchResults.java
Outdated
Show resolved
Hide resolved
ua/org.eclipse.help.base/src/org/eclipse/help/internal/search/federated/LocalHelp.java
Outdated
Show resolved
Hide resolved
ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/data/SearchData.java
Outdated
Show resolved
Hide resolved
The `org.eclipse.help.searchProcessor` extension point allows to modify the help search results. This is done by calling the `postSearch(...)` method of all implementations of `org.eclipse.help.search.AbstractSearchProcessor` specified by this extension point. In some cases, the search results to be modified and the query that are passed as parameters to the `postSearch(...)` method may not be enough. So this change adds another `postSearch(...)` method with additional parameters like the locale and the scopes if any. The simpler `postSearch(...)` is be kept for backward compatibility. Additionally, if `preSearch(...)` returns a `SearchProcessorInfo` with an empty, non-`null` query (`""`), no search will be executed, resulting in no search results or in the search results that has been added via `postSearch(...)`.
howlger
force-pushed
the
patch-searchProcessor
branch
from
a202f0c to
1a7c801
Compare
|
The test failure seems to be |
|
I've rerun Windows build, it is OK now. Thanks. Will try to reviewtomorrow. |
|
Thanks everyone for your feedback and for applying. |
|
You are welcome Holger. |
Wrong with the initial contribution eclipse-platform#1725
Wrong with the initial contribution #1725
4 participants
The
org.eclipse.help.searchProcessorextension point allows to modify the help search results. This is done by calling thepostSearch(...)method of all implementations oforg.eclipse.help.search.AbstractSearchProcessorspecified by this extension point. In some cases, the search results to be modified and the query that are passed as parameters to thepostSearch(...)method may not be enough. So this change adds anotherpostSearch(...)method with additional parameters like the locale and the scopes if any. The simplerpostSearch(...)is be kept for backward compatibility.Additionally, if
preSearch(...)returns aSearchProcessorInfowith an empty, non-nullquery (""), no search will be executed, resulting in no search results or in the search results that has been added viapostSearch(...).