public interface QueryMonitorPlugin extends PreFederatedQueryPlugin, PostFederatedQueryPlugin
QueryMonitorPlugin
monitors ActiveSearches by maintaining a Map
with a key of
UUID
and a value of ActiveSearch
. QueryMonitorPlugin
extends both PreFederatedQueryPlugin
and PostFederatedQueryPlugin
in order to process each search for
every source. The PreFederatedQueryPlugin
should be implemented to add the ActiveSearch
to the Map
and the PostFederatedQueryPlugin
should be implemented
to remove the ActiveSearch
from the Map
.Modifier and Type | Method and Description |
---|---|
boolean |
addActiveSearch(ActiveSearch as)
Adds an ActiveSearch to the
ActiveSearch Map |
Map<UUID,ActiveSearch> |
getActiveSearches()
Returns a copy of the
ActiveSearch Map |
boolean |
removeActiveSearch(UUID id)
Removes an ActiveSearch from the
ActiveSearch Map using it's UUID as a key |
void |
setRemoveSearchAfterComplete(boolean b)
Sets a boolean which determines whether or not searches will be removed from the
ActiveSearch Map upon search completion. |
process
process
Map<UUID,ActiveSearch> getActiveSearches()
ActiveSearch
Map
Map
<UUID
, ActiveSearch
> copy of the ActiveSearch
Map
void setRemoveSearchAfterComplete(boolean b)
ActiveSearch
Map
upon search completion. A value of true will remove searches from the
Map
as the searches finish and a value of false will keep the searches in the Map
after they complete.b
- boolean value. A value of false will keep ActiveSearch
's in the Map
even after they finish (are no longer active). True will remove the ActiveSearches from the
Map
as the searches complete (default behavior is true)boolean removeActiveSearch(UUID id)
ActiveSearch
Map
using it's UUID as a keyboolean addActiveSearch(ActiveSearch as)
ActiveSearch
Map
as
- ActiveSearch that will be added to the Map
ActiveSearch
was successfulThis work is licensed under a Creative Commons Attribution 4.0 International License.