net.yacy.cora.federate

Class AbstractFederateSearchConnector

java.lang.Object

net.yacy.cora.federate.AbstractFederateSearchConnector

All Implemented Interfaces:

FederateSearchConnector

Direct Known Subclasses:

OpenSearchConnector, SolrFederateSearchConnector

public abstract class AbstractFederateSearchConnector
extends java.lang.Object
implements FederateSearchConnector

Base implementation class for Federated Search Connectors providing the basic funcitonality to search none YaCy systems

• init() to read config file
• toYaCySchema() to convert remote schema fields to YaCy internal schema names, called by query()
• query() needs to be implemented in specific connectors
• search() call's query() in a thread and adds results to internal search request.

Subclasses should/need to override query() and maybe toYaCySchema() if more is needed as a basic field mapping

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseurl
java.lang.String	instancename
long	lastaccesstime
protected SchemaConfiguration	localcfg

Constructor Summary

Constructors

Constructor and Description
AbstractFederateSearchConnector()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	init(java.lang.String instance, java.lang.String cfgFileName) Inits the connector with the remote field names and matches to yacy schema and other specific settings from config file.
void	search(SearchEvent theSearch) queries a remote system and adds the results to the searchevent and to the crawler if addResultsToLocalIndex is true
protected URIMetadataNode	toYaCySchema(SolrDocument doc) Converts a remote schema result to YaCy schema using the fieldname mapping provided as config file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.yacy.cora.federate.FederateSearchConnector

query

Field Detail

instancename

public java.lang.String instancename

localcfg

protected SchemaConfiguration localcfg

lastaccesstime

public long lastaccesstime

baseurl

protected java.lang.String baseurl

Constructor Detail

AbstractFederateSearchConnector

public AbstractFederateSearchConnector()

Method Detail

init

public boolean init(java.lang.String instance,
           java.lang.String cfgFileName)

Inits the connector with the remote field names and matches to yacy schema and other specific settings from config file. 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)

Specified by:

init in interface FederateSearchConnector

Parameters:

instanceName - internal name

cfgFileName - e.g. DATA/SETTINGS/FEDERATECFG/instanceName.SCHEMA

Returns:

true if success false if not

search

public void search(SearchEvent theSearch)

queries a remote system and adds the results to the searchevent and to the crawler if addResultsToLocalIndex is true

Specified by:

search in interface FederateSearchConnector

Parameters:

theSearch - receiving the results

toYaCySchema

protected URIMetadataNode toYaCySchema(SolrDocument doc)
                                throws java.net.MalformedURLException

Converts a remote schema result to YaCy schema using the fieldname mapping provided as config file

Parameters:

remote - result (with remote fieldnames)

Returns:

SolrDocument with field names according to the YaCy schema

Throws:

java.net.MalformedURLException