net.yacy.cora.federate.solr.connector

Interface SolrConnector

All Superinterfaces:

java.lang.Iterable<java.lang.String>

All Known Implementing Classes:

AbstractSolrConnector, ConcurrentUpdateSolrConnector, EmbeddedSolrConnector, MirrorSolrConnector, RemoteSolrConnector, SolrServerConnector

public interface SolrConnector
extends java.lang.Iterable<java.lang.String>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SolrConnector.LoadTimeURL

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.util.Collection<SolrInputDocument> solrdoc) add a collection of solr input documents
void	add(SolrInputDocument solrdoc) add a solr input document
int	bufferSize() get the size of a write buffer (if any) of pending write requests
void	clear() delete everything in the solr index
void	clearCaches() clear all caches: inside solr and ouside solr within the implementations of this interface
void	close() close the server connection
void	commit(boolean softCommit) force a commit
java.util.concurrent.BlockingQueue<SolrDocument>	concurrentDocumentsByQueries(java.util.List<java.lang.String> querystrings, java.lang.String sort, int offset, int maxcount, long maxtime, int buffersize, int concurrency, boolean prefetchIDs, java.lang.String... fields) Get results from solr queries as a stream of documents.
java.util.concurrent.BlockingQueue<SolrDocument>	concurrentDocumentsByQuery(java.lang.String querystring, java.lang.String sort, int offset, int maxcount, long maxtime, int buffersize, int concurrency, boolean prefetchIDs, java.lang.String... fields) Get results from a solr query as a stream of documents.
java.util.concurrent.BlockingQueue<java.lang.String>	concurrentIDsByQueries(java.util.List<java.lang.String> querystrings, java.lang.String sort, int offset, int maxcount, long maxtime, int buffersize, int concurrency) get a document id result stream from a set of solr queries.
java.util.concurrent.BlockingQueue<java.lang.String>	concurrentIDsByQuery(java.lang.String querystring, java.lang.String sort, int offset, int maxcount, long maxtime, int buffersize, int concurrency) get a document id result stream from a solr query.
void	deleteById(java.lang.String id) delete an entry from solr using the url hash as document id
void	deleteByIds(java.util.Collection<java.lang.String> ids) delete a set of entries from solr; entries are identified by their url hash
void	deleteByQuery(java.lang.String querystring) delete entries from solr according the given solr query string
long	getCountByQuery(java.lang.String querystring) get the number of results when this query is done.
SolrDocument	getDocumentById(java.lang.String key, java.lang.String... fields) get a document from solr by given key for the id-field
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.
SolrDocumentList	getDocumentListByQuery(java.lang.String querystring, java.lang.String sort, int offset, int count, java.lang.String... fields) get a query result from solr to get all results set the query String to "*:*"
java.util.LinkedHashMap<java.lang.String,ReversibleScoreMap<java.lang.String>>	getFacets(java.lang.String query, int maxresults, java.lang.String... fields) get facets of the index: a list of lists with values that are most common in a specific field
SolrConnector.LoadTimeURL	getLoadTimeURL(java.lang.String id) check if a given document, identified by url hash as document id exists
QueryResponse	getResponseByParams(ModifiableSolrParams query) get a "full" query response from solr.
int	getSegmentCount() ask the solr subsystem about it's segment number
long	getSize() get the size of the index
boolean	isClosed() test if the connector is already closed
void	optimize(int maxSegments) force an explicit merge of segments
void	update(java.util.Collection<SolrInputDocument> solrdoc) Update a collection of solr input documents.
void	update(SolrInputDocument solrdoc) Update a solr document.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

clearCaches

void clearCaches()

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

bufferSize

int bufferSize()

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

getSize

long getSize()

get the size of the index

Returns:

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

commit

void commit(boolean softCommit)

force a commit

optimize

void optimize(int maxSegments)

force an explicit merge of segments

Parameters:

maxSegments - the maximum number of segments. Set to 1 for maximum optimization

getSegmentCount

int getSegmentCount()

ask the solr subsystem about it's segment number

Returns:

the segment count, which corresponds to the number of files for an index

isClosed

boolean isClosed()

test if the connector is already closed

Returns:

true if the connector is closed

close

void close()

close the server connection

clear

void clear()
           throws java.io.IOException

delete everything in the solr index

Throws:

java.io.IOException

deleteById

void deleteById(java.lang.String id)
                throws java.io.IOException

delete an entry from solr using the url hash as document id

Parameters:

id - the url hash of the entry

Throws:

java.io.IOException

deleteByIds

void deleteByIds(java.util.Collection<java.lang.String> ids)
                 throws java.io.IOException

delete a set of entries from solr; entries are identified by their url hash

Parameters:

ids - a list of url hashes

Throws:

java.io.IOException

deleteByQuery

void deleteByQuery(java.lang.String querystring)
                   throws java.io.IOException

delete entries from solr according the given solr query string

Parameters:

querystring -

Throws:

java.io.IOException

getLoadTimeURL

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

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

Parameters:

id - the url hash and document id

Returns:

the load time metadata (url and load data) if any entry in solr exists, null otherwise

Throws:

java.io.IOException

add

void add(SolrInputDocument solrdoc)
         throws java.io.IOException,
                SolrException

add a solr input document

Parameters:

solrdoc -

Throws:

java.io.IOException

SolrException

update

void update(SolrInputDocument solrdoc)
            throws java.io.IOException,
                   SolrException

Update a solr document. This will write only a partial update for all fields given in the SolrInputDocument and leaves all other fields untouched.

Parameters:

solrdoc -

Throws:

java.io.IOException

SolrException

add

void add(java.util.Collection<SolrInputDocument> solrdoc)
         throws java.io.IOException,
                SolrException

add a collection of solr input documents

Parameters:

solrdocs -

Throws:

java.io.IOException

SolrException

update

void update(java.util.Collection<SolrInputDocument> solrdoc)
            throws java.io.IOException,
                   SolrException

Update a collection of solr input documents. This will write only a partial update for all fields given in the SolrInputDocuments and leaves all other fields untouched.

Parameters:

solrdocs -

Throws:

java.io.IOException

SolrException

getDocumentById

SolrDocument getDocumentById(java.lang.String key,
                           java.lang.String... fields)
                             throws java.io.IOException

get a document from solr by given key for the id-field

Parameters:

key -

fields - list of fields

Returns:

one result or null if no result exists

Throws:

java.io.IOException

getResponseByParams

QueryResponse getResponseByParams(ModifiableSolrParams query)
                                  throws java.io.IOException

get a "full" query response from solr. Please compare to getSolrDocumentListByParams which may be much more efficient

Parameters:

query -

Throws:

java.io.IOException

getDocumentListByParams

SolrDocumentList getDocumentListByParams(ModifiableSolrParams params)
                                         throws java.io.IOException

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.

Parameters:

params -

Returns:

Throws:

java.io.IOException

SolrException

getDocumentListByQuery

SolrDocumentList getDocumentListByQuery(java.lang.String querystring,
                                      java.lang.String sort,
                                      int offset,
                                      int count,
                                      java.lang.String... fields)
                                        throws java.io.IOException

get a query result from solr to get all results set the query String to "*:*"

Parameters:

querystring - the solr query string

sort - the solr sort string, may be null to be not used

offset - the first result offset

count - number of wanted results

fields - list of fields

Throws:

java.io.IOException

getCountByQuery

long getCountByQuery(java.lang.String querystring)
                     throws java.io.IOException

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

Parameters:

querystring -

Returns:

the number of results for this query

Throws:

java.io.IOException

getFacets

java.util.LinkedHashMap<java.lang.String,ReversibleScoreMap<java.lang.String>> getFacets(java.lang.String query,
                                                                                       int maxresults,
                                                                                       java.lang.String... fields)
                                                                                         throws java.io.IOException

get facets of the index: a list of lists with values that are most common in a specific field

Parameters:

query - a query which is performed to get the facets

maxresults - the maximum size of the resulting maps

fields - the field names which are selected as facet

Returns:

a map with key = facet field name, value = an ordered map of field values for that field

Throws:

java.io.IOException

concurrentDocumentsByQuery

java.util.concurrent.BlockingQueue<SolrDocument> concurrentDocumentsByQuery(java.lang.String querystring,
                                                                          java.lang.String sort,
                                                                          int offset,
                                                                          int maxcount,
                                                                          long maxtime,
                                                                          int buffersize,
                                                                          int concurrency,
                                                                          boolean prefetchIDs,
                                                                          java.lang.String... fields)

Get results from a solr query as a stream of documents. The result queue is considered as terminated if AbstractSolrConnector.POISON_DOCUMENT is returned. The method returns immediately and feeds the search results into the queue

Parameters:

querystring - the solr query string

sort - the solr sort string, may be null to be not used

offset - first result offset

maxcount - the maximum number of results

maxtime - the maximum time in milliseconds

buffersize - the size of an ArrayBlockingQueue; if <= 0 then a LinkedBlockingQueue is used

concurrency - is the number of AbstractSolrConnector.POISON_DOCUMENT entries to add at the end of the feed

prefetchIDs - if true, then first all IDs are fetched and then all documents are queries by the ID. If false then documents are retrieved directly

fields - list of fields

Returns:

a blocking queue which is terminated with AbstractSolrConnector.POISON_DOCUMENT as last element

concurrentDocumentsByQueries

java.util.concurrent.BlockingQueue<SolrDocument> concurrentDocumentsByQueries(java.util.List<java.lang.String> querystrings,
                                                                            java.lang.String sort,
                                                                            int offset,
                                                                            int maxcount,
                                                                            long maxtime,
                                                                            int buffersize,
                                                                            int concurrency,
                                                                            boolean prefetchIDs,
                                                                            java.lang.String... fields)

Get results from solr queries as a stream of documents. The result queue is considered as terminated if AbstractSolrConnector.POISON_DOCUMENT is returned. The method returns immediately and feeds the search results into the queue

Parameters:

querystrings - the list of solr query strings

sort - the solr sort string, may be null to be not used

offset - first result offset

maxcount - the maximum number of results

maxtime - the maximum time in milliseconds

buffersize - the size of an ArrayBlockingQueue; if <= 0 then a LinkedBlockingQueue is used

concurrency - is the number of AbstractSolrConnector.POISON_DOCUMENT entries to add at the end of the feed

prefetchIDs - if true, then first all IDs are fetched and then all documents are queries by the ID. If false then documents are retrieved directly

fields - list of fields

Returns:

a blocking queue which is terminated with AbstractSolrConnector.POISON_DOCUMENT as last element

concurrentIDsByQuery

java.util.concurrent.BlockingQueue<java.lang.String> concurrentIDsByQuery(java.lang.String querystring,
                                                                        java.lang.String sort,
                                                                        int offset,
                                                                        int maxcount,
                                                                        long maxtime,
                                                                        int buffersize,
                                                                        int concurrency)

get a document id result stream from a solr query. The result queue is considered as terminated if AbstractSolrConnector.POISON_ID is returned. The method returns immediately and feeds the search results into the queue

Parameters:

querystring -

sort - the solr sort string, may be null to be not used

offset -

maxcount -

buffersize - the size of an ArrayBlockingQueue; if <= 0 then a LinkedBlockingQueue is used

concurrency - is the number of AbstractSolrConnector.POISON_ID entries to add at the end of the feed

Returns:

a list of ids in q blocking queue which is terminated with a number of AbstractSolrConnector.POISON_ID

concurrentIDsByQueries

java.util.concurrent.BlockingQueue<java.lang.String> concurrentIDsByQueries(java.util.List<java.lang.String> querystrings,
                                                                          java.lang.String sort,
                                                                          int offset,
                                                                          int maxcount,
                                                                          long maxtime,
                                                                          int buffersize,
                                                                          int concurrency)

get a document id result stream from a set of solr queries. The result queue is considered as terminated if AbstractSolrConnector.POISON_ID is returned. The method returns immediately and feeds the search results into the queue

Parameters:

querystring - a list of query strings

sort - the solr sort string, may be null to be not used

offset - common offset of all queries

maxcount - maximum count for each query

buffersize - the size of an ArrayBlockingQueue; if <= 0 then a LinkedBlockingQueue is used

concurrency - is the number of AbstractSolrConnector.POISON_ID entries to add at the end of the feed

Returns:

a list of ids in q blocking queue which is terminated with a number of AbstractSolrConnector.POISON_ID