de.tudarmstadt.ukp.dkpro.core.io.solr

Class SolrWriter_ImplBase

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasConsumer_ImplBase

de.tudarmstadt.ukp.dkpro.core.io.solr.SolrWriter_ImplBase

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

SolrWriter

public abstract class SolrWriter_ImplBase
extends org.apache.uima.fit.component.JCasConsumer_ImplBase

This class implements a basic SolrWriter. Specific writers should define a subclass that overwrites the generateSolrDocument() method to take custom fields into account.

The class initializes a SolrServer instance, and calls generateSolrDocument() for each incoming CAS, and adds the result to the Solr server. A commit is executed when all documents are processed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_ID_FIELD The name of the id field in the Solr schema (default: "id").
static String	PARAM_NUM_THREADS The number of background numThreads used to empty the queue.
static String	PARAM_OPTIMIZE_INDEX If set to true, the index is optimized once all documents are uploaded.
static String	PARAM_QUEUE_SIZE The buffer size before the documents are sent to the server (default: 10000).
static String	PARAM_TARGET_LOCATION Solr server URL string in the form <prot>://<host>:<port>/<path>, e.g.
static String	PARAM_TEXT_FIELD The name of the text field in the Solr schema (default: "text").
static String	PARAM_UPDATE Define whether existing documents with same ID are updated (true) of overwritten (false)? Default: true (update).
static String	PARAM_WAIT_FLUSH When committing to the index, i.e.
static String	PARAM_WAIT_SEARCHER When committing to the index, i.e.

Constructor Summary

Constructors

Constructor and Description
SolrWriter_ImplBase()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
protected abstract org.apache.solr.common.SolrInputDocument	generateSolrDocument(org.apache.uima.jcas.JCas aJCas)
String	getIdField()
org.apache.solr.client.solrj.SolrClient	getSolrClient()
String	getTextField()
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas aJCas)
boolean	update() Perform updates if added documents already exist?

Methods inherited from class org.apache.uima.fit.component.JCasConsumer_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_UPDATE

public static final String PARAM_UPDATE

Define whether existing documents with same ID are updated (true) of overwritten (false)? Default: true (update).

See Also:

Constant Field Values

PARAM_TARGET_LOCATION

public static final String PARAM_TARGET_LOCATION

Solr server URL string in the form <prot>://<host>:<port>/<path>, e.g. http://localhost:8983/solr/collection1

See Also:

Constant Field Values

PARAM_QUEUE_SIZE

public static final String PARAM_QUEUE_SIZE

The buffer size before the documents are sent to the server (default: 10000).

See Also:

Constant Field Values

PARAM_NUM_THREADS

public static final String PARAM_NUM_THREADS

The number of background numThreads used to empty the queue. Default: 1.

See Also:

Constant Field Values

PARAM_WAIT_FLUSH

public static final String PARAM_WAIT_FLUSH

When committing to the index, i.e. when all documents are processed, block until index changes are flushed to disk? Default: true.

See Also:

Constant Field Values

PARAM_WAIT_SEARCHER

public static final String PARAM_WAIT_SEARCHER

When committing to the index, i.e. when all documents are processed, block until a new searcher is opened and registered as the main query searcher, making the changes visible? Default: true.

See Also:

Constant Field Values

PARAM_TEXT_FIELD

public static final String PARAM_TEXT_FIELD

The name of the text field in the Solr schema (default: "text").

See Also:

Constant Field Values

PARAM_ID_FIELD

public static final String PARAM_ID_FIELD

The name of the id field in the Solr schema (default: "id").

See Also:

Constant Field Values

PARAM_OPTIMIZE_INDEX

public static final String PARAM_OPTIMIZE_INDEX

If set to true, the index is optimized once all documents are uploaded. Default is false.

See Also:

Constant Field Values

Constructor Detail

SolrWriter_ImplBase

public SolrWriter_ImplBase()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.JCasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas aJCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

collectionProcessComplete

public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

update

public boolean update()

Perform updates if added documents already exist?

Returns:

true if updates are to be performed rather than overwriting existing documents

getTextField

public String getTextField()

Returns:

the name of the Solr text field (e.g. "text")

getIdField

public String getIdField()

Returns:

the name of the Solr ID field (e.g. "id")

getSolrClient

public org.apache.solr.client.solrj.SolrClient getSolrClient()

Returns:

the SolrClient

generateSolrDocument

protected abstract org.apache.solr.common.SolrInputDocument generateSolrDocument(org.apache.uima.jcas.JCas aJCas)
                                                                          throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException