net.yacy.cora.federate.opensearch

Class OpenSearchConnector

java.lang.Object

net.yacy.cora.federate.AbstractFederateSearchConnector

net.yacy.cora.federate.opensearch.OpenSearchConnector

All Implemented Interfaces:

FederateSearchConnector

public class OpenSearchConnector
extends AbstractFederateSearchConnector
implements FederateSearchConnector

Handling of queries to remote OpenSearch systems. Iterates to a list of configured systems until number of needed results are available.

Field Summary

Fields inherited from class net.yacy.cora.federate.AbstractFederateSearchConnector

baseurl, instancename, lastaccesstime, localcfg

Constructor Summary

Constructors

Constructor and Description
OpenSearchConnector()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	init(java.lang.String name, java.lang.String urltemplate) Inits the connector with the remote field names and matches to yacy schema and other specific settings from config file.
private java.lang.String	parseSearchTemplate(java.lang.String searchurltemplate, java.lang.String query, int start, int rows) replace Opensearchdescription search template parameter with actual values
java.util.List<URIMetadataNode>	query(QueryParams query) queries remote system and returns the resultlist (waits until results transmitted or timeout) This is the main access routine used for the serach and query operation For internal access delay time, also the this.lastaccessed time needs to be set here.

Methods inherited from class net.yacy.cora.federate.AbstractFederateSearchConnector

search, toYaCySchema

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

search

Constructor Detail

OpenSearchConnector

public OpenSearchConnector()

Method Detail

init

public boolean init(java.lang.String name,
           java.lang.String urltemplate)

Description copied from class: AbstractFederateSearchConnector

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

Overrides:

init in class AbstractFederateSearchConnector

Parameters:

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

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

Returns:

true if success false if not

parseSearchTemplate

private java.lang.String parseSearchTemplate(java.lang.String searchurltemplate,
                                   java.lang.String query,
                                   int start,
                                   int rows)

replace Opensearchdescription search template parameter with actual values

query

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

queries remote system and returns the resultlist (waits until results transmitted or timeout) This is the main access routine used for the serach and query operation For internal access delay time, also the this.lastaccessed time needs to be set here.

Specified by:

query in interface FederateSearchConnector

Returns:

query results (metadata) with fields according to YaCy schema