net.yacy.cora.federate.solr.connector

Class EmbeddedSolrConnector

java.lang.Object

net.yacy.cora.federate.solr.connector.AbstractSolrConnector

net.yacy.cora.federate.solr.connector.SolrServerConnector

net.yacy.cora.federate.solr.connector.EmbeddedSolrConnector

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, SolrConnector

public class EmbeddedSolrConnector
extends SolrServerConnector
implements SolrConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	EmbeddedSolrConnector.DocListSearcher

Nested classes/interfaces inherited from interface net.yacy.cora.federate.solr.connector.SolrConnector

SolrConnector.LoadTimeURL

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT
private SolrCore	core
private EmbeddedInstance	instance
private SearchHandler	requestHandler
private java.util.Map<java.lang.String,SchemaField>	schemaFieldCache The following schemaFieldCache is a hack-patch of a Solr internal request which is really slow.
static java.lang.String	SELECT

Fields inherited from class net.yacy.cora.federate.solr.connector.SolrServerConnector

classLoaderSynchro, log, server

Fields inherited from class net.yacy.cora.federate.solr.connector.AbstractSolrConnector

CATCHALL_DTERM, CATCHALL_QUERY, CATCHALL_TERM, catchallQuery, catchSuccessQuery, pagesize_docs, pagesize_ids, POISON_DOCUMENT, POISON_ID, SOLR_ID_and_LOAD_DATE_FIELDS, SOLR_ID_FIELDS

Constructor Summary

Constructors

Constructor and Description
EmbeddedSolrConnector(EmbeddedInstance instance)
EmbeddedSolrConnector(EmbeddedInstance instance, java.lang.String coreName)

Method Summary

Methods

Modifier and Type	Method and Description
int	bufferSize() get the size of a write buffer (if any) of pending write requests
void	clearCaches() clear all caches: inside solr and ouside solr within the implementations of this interface
void	close() close the server connection
SolrDocument	doc2SolrDoc(Document doc)
boolean	equals(java.lang.Object o)
protected void	finalize()
SolrConfig	getConfig()
SolrCore	getCore()
long	getCountByQuery(java.lang.String querystring) get the number of results when this query is done.
SolrDocumentList	getDocumentListByParams(ModifiableSolrParams params) get the solr document list from a query response This differs from getResponseByParams in such a way that it does only create the fields of the response but never search snippets and there are also no facets generated.
SolrInstance	getInstance()
SolrConnector.LoadTimeURL	getLoadTimeURL(java.lang.String id) check if a given document, identified by url hash as document id exists
QueryResponse	getResponseByParams(ModifiableSolrParams params) the usage of getResponseByParams is disencouraged for the embedded Solr connector.
private SchemaField	getSchemaField(java.lang.String fieldName)
long	getSize() get the size of the index
java.util.Map<java.lang.String,SolrInfoMBean>	getSolrInfoBeans()
int	hashCode()
boolean	isClosed() test if the connector is already closed
SolrQueryResponse	query(SolrQueryRequest req)
SolrQueryRequest	request(SolrParams params) get a new query request.
SolrDocumentList	SolrQueryResponse2SolrDocumentList(SolrQueryRequest req, SolrQueryResponse rsp) conversion from a SolrQueryResponse (which is a solr-internal data format) to SolrDocumentList (which is a solrj-format) The conversion is done inside the solrj api using the BinaryResponseWriter and a very complex unfolding process via org.apache.solr.common.util.JavaBinCodec.marshal.

Methods inherited from class net.yacy.cora.federate.solr.connector.SolrServerConnector

add, add, add, clear, commit, deleteById, deleteByIds, deleteByQuery, getFields, getSegmentCount, getServer, init, optimize

Methods inherited from class net.yacy.cora.federate.solr.connector.AbstractSolrConnector

concurrentDocumentsByQueries, concurrentDocumentsByQuery, concurrentIDsByQueries, concurrentIDsByQuery, ensureEssentialFieldsIncluded, getDocumentById, getDocumentListByQuery, getFacets, getLoadTimeURL, getSolrQuery, iterator, update, update

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.yacy.cora.federate.solr.connector.SolrConnector

add, add, clear, commit, concurrentDocumentsByQueries, concurrentDocumentsByQuery, concurrentIDsByQueries, concurrentIDsByQuery, deleteById, deleteByIds, deleteByQuery, getDocumentById, getDocumentListByQuery, getFacets, getSegmentCount, optimize, update, update

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

SELECT

public static final java.lang.String SELECT

See Also:

Constant Field Values

CONTEXT

public static final java.lang.String CONTEXT

See Also:

Constant Field Values

requestHandler

private final SearchHandler requestHandler

instance

private final EmbeddedInstance instance

core

private final SolrCore core

schemaFieldCache

private final java.util.Map<java.lang.String,SchemaField> schemaFieldCache

The following schemaFieldCache is a hack-patch of a Solr internal request which is really slow. The Solr-internal method is flexible because it may respond on a real-time schema change, but that effectively never happens. In our case the schema declaration against Solr never changes.

Constructor Detail

EmbeddedSolrConnector

public EmbeddedSolrConnector(EmbeddedInstance instance)

EmbeddedSolrConnector

public EmbeddedSolrConnector(EmbeddedInstance instance,
                     java.lang.String coreName)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

bufferSize

public int bufferSize()

Description copied from interface: SolrConnector

get the size of a write buffer (if any) of pending write requests

Specified by:

bufferSize in interface SolrConnector

getSolrInfoBeans

public java.util.Map<java.lang.String,SolrInfoMBean> getSolrInfoBeans()

clearCaches

public void clearCaches()

Description copied from interface: SolrConnector

clear all caches: inside solr and ouside solr within the implementations of this interface

Specified by:

clearCaches in interface SolrConnector

getInstance

public SolrInstance getInstance()

getCore

public SolrCore getCore()

getConfig

public SolrConfig getConfig()

isClosed

public boolean isClosed()

Description copied from interface: SolrConnector

test if the connector is already closed

Specified by:

isClosed in interface SolrConnector

Overrides:

isClosed in class SolrServerConnector

Returns:

true if the connector is closed

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Description copied from interface: SolrConnector

close the server connection

Specified by:

close in interface SolrConnector

Overrides:

close in class SolrServerConnector

getSize

public long getSize()

Description copied from interface: SolrConnector

get the size of the index

Specified by:

getSize in interface SolrConnector

Overrides:

getSize in class SolrServerConnector

Returns:

number of results if solr is queries with a catch-all pattern

request

public SolrQueryRequest request(SolrParams params)

get a new query request. MUST be closed after usage using close()

Parameters:

params -

Returns:

query

public SolrQueryResponse query(SolrQueryRequest req)
                        throws SolrException

Throws:

SolrException

SolrQueryResponse2SolrDocumentList

public SolrDocumentList SolrQueryResponse2SolrDocumentList(SolrQueryRequest req,
                                                  SolrQueryResponse rsp)

conversion from a SolrQueryResponse (which is a solr-internal data format) to SolrDocumentList (which is a solrj-format) The conversion is done inside the solrj api using the BinaryResponseWriter and a very complex unfolding process via org.apache.solr.common.util.JavaBinCodec.marshal.

Parameters:

request -

sqr -

Returns:

getSchemaField

private final SchemaField getSchemaField(java.lang.String fieldName)

doc2SolrDoc

public SolrDocument doc2SolrDoc(Document doc)

getResponseByParams

public QueryResponse getResponseByParams(ModifiableSolrParams params)
                                  throws java.io.IOException

the usage of getResponseByParams is disencouraged for the embedded Solr connector. Please use request(SolrParams) instead. Reason: Solr makes a very complex folding/unfolding including data compression for SolrQueryResponses.

Specified by:

getResponseByParams in interface SolrConnector

Throws:

java.io.IOException

getDocumentListByParams

public SolrDocumentList getDocumentListByParams(ModifiableSolrParams params)
                                         throws java.io.IOException,
                                                SolrException

get the solr document list from a query response This differs from getResponseByParams in such a way that it does only create the fields of the response but never search snippets and there are also no facets generated.

Specified by:

getDocumentListByParams in interface SolrConnector

Overrides:

getDocumentListByParams in class SolrServerConnector

Parameters:

params -

Returns:

Throws:

java.io.IOException

SolrException

getCountByQuery

public long getCountByQuery(java.lang.String querystring)

Description copied from class: AbstractSolrConnector

get the number of results when this query is done. This should only be called if the actual result is never used, and only the count is interesting

Specified by:

getCountByQuery in interface SolrConnector

Overrides:

getCountByQuery in class AbstractSolrConnector

Returns:

the number of results for this query

getLoadTimeURL

public SolrConnector.LoadTimeURL getLoadTimeURL(java.lang.String id)
                                         throws java.io.IOException

check if a given document, identified by url hash as document id exists

Specified by:

getLoadTimeURL in interface SolrConnector

Overrides:

getLoadTimeURL in class AbstractSolrConnector

Parameters:

id - the url hash and document id

Returns:

the load date if any entry in solr exists, -1 otherwise

Throws:

java.io.IOException