org.myrobotlab.service

Class Solr

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.Solr

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, DocumentListener, QueueReporter

public class Solr
extends Service
implements DocumentListener

SolrService - MyRobotLab This is an integration of Solr into MyRobotLab. Solr is the popular, blazing-fast, open source enterprise search platform built on Apache Lucene. This service exposes a the solrj client to be able to add documents and query a solr server that is running. For More info about Solr see http://lucene.apache.org/solr/

Author:

kwatters

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	commitOnFlush
static org.slf4j.Logger	log
java.lang.String	solrUrl

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
Solr(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	addDocument(org.apache.solr.common.SolrInputDocument doc)
void	addDocuments(java.util.Collection<org.apache.solr.common.SolrInputDocument> docs) Add a solr document to the index
void	commit() Commit the solr index and make documents that have been submitted become searchable.
void	deleteDocument(java.lang.String docId)
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getSolrUrl()
boolean	isCommitOnFlush()
static void	main(java.lang.String[] args)
ProcessingStatus	onDocument(Document doc)
ProcessingStatus	onDocuments(java.util.List<Document> docs)
boolean	onFlush()
void	optimize() Optimize the index, if the index gets very fragmented, this helps optimize performance and helps reclaim some disk space.
org.apache.solr.client.solrj.response.QueryResponse	publishResults(org.apache.solr.client.solrj.response.QueryResponse resp)
org.apache.solr.client.solrj.response.QueryResponse	search(org.apache.solr.client.solrj.SolrQuery query) Pass in custom solr query parameters and execute that query.
org.apache.solr.client.solrj.response.QueryResponse	search(java.lang.String queryString)
org.apache.solr.client.solrj.response.QueryResponse	search(java.lang.String queryString, int rows, int start)
void	setCommitOnFlush(boolean commitOnFlush)
void	setSolrUrl(java.lang.String solrUrl)
void	startService()

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.myrobotlab.service.interfaces.DocumentListener

getName

Field Detail

log

public static final org.slf4j.Logger log

solrUrl

public java.lang.String solrUrl

commitOnFlush

public boolean commitOnFlush

Constructor Detail

Solr

public Solr(java.lang.String n)

Method Detail

main

public static void main(java.lang.String[] args)

addDocument

public void addDocument(org.apache.solr.common.SolrInputDocument doc)

addDocuments

public void addDocuments(java.util.Collection<org.apache.solr.common.SolrInputDocument> docs)

Add a solr document to the index

Parameters:

docs - a collection of solr input docs to add to solr.

commit

public void commit()

Commit the solr index and make documents that have been submitted become searchable.

deleteDocument

public void deleteDocument(java.lang.String docId)

getSolrUrl

public java.lang.String getSolrUrl()

Returns:

The url for the solr instance you wish to query. Defaults to http://localhost:8983/solr

optimize

public void optimize()

Optimize the index, if the index gets very fragmented, this helps optimize performance and helps reclaim some disk space.

search

public org.apache.solr.client.solrj.response.QueryResponse search(org.apache.solr.client.solrj.SolrQuery query)

Pass in custom solr query parameters and execute that query.

Parameters:

query - the query to execute

Returns:

a query response from solr

search

public org.apache.solr.client.solrj.response.QueryResponse search(java.lang.String queryString)

search

public org.apache.solr.client.solrj.response.QueryResponse search(java.lang.String queryString,
                                                                  int rows,
                                                                  int start)

publishResults

public org.apache.solr.client.solrj.response.QueryResponse publishResults(org.apache.solr.client.solrj.response.QueryResponse resp)

setSolrUrl

public void setSolrUrl(java.lang.String solrUrl)

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

onDocuments

public ProcessingStatus onDocuments(java.util.List<Document> docs)

Specified by:

onDocuments in interface DocumentListener

onDocument

public ProcessingStatus onDocument(Document doc)

Specified by:

onDocument in interface DocumentListener

onFlush

public boolean onFlush()

Specified by:

onFlush in interface DocumentListener

isCommitOnFlush

public boolean isCommitOnFlush()

setCommitOnFlush

public void setCommitOnFlush(boolean commitOnFlush)

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data