net.yacy.cora.federate

Interface FederateSearchConnector

All Known Implementing Classes:

AbstractFederateSearchConnector, OpenSearchConnector, SolrFederateSearchConnector

public interface FederateSearchConnector

Interface for a query connector to search and gather query results from none YaCy systems (for the YaCy heuristic options)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	init(java.lang.String instanceName, java.lang.String cfg) Load the configuration for this connector every connector needs at least a query target (where to query) and some definition to convert the remote serch result to the internal result presentation (field mapping)
java.util.List<URIMetadataNode>	query(QueryParams query) Queries a remote system and returns the search result with field names according to YaCy schema.
void	search(SearchEvent theSearch) Queries a remote system and adds the result metadata to the search events result list.

Method Detail

init

boolean init(java.lang.String instanceName,
           java.lang.String cfg)

Load the configuration for this connector every connector needs at least a query target (where to query) and some definition to convert the remote serch result to the internal result presentation (field mapping)

Parameters:

instanceName - is also the name of the config file DATA/SETTINGS/instanceName.schema

cfg - config parameter

Returns:

true if success false if not

search

void search(SearchEvent theSearch)

Queries a remote system and adds the result metadata to the search events result list. If SearchEvent.addResultsToLocalIndex (=default) result urls are added to the crawler.

Parameters:

theSearch -

query

java.util.List<URIMetadataNode> query(QueryParams query)

Queries a remote system and returns the search result with field names according to YaCy schema.

Parameters:

query -

Returns:

result (metadata) in YaCy schema format