org.phenotips.vocabulary

Interface SolrVocabularyResourceManager

@Unstable
 @Role
public interface SolrVocabularyResourceManager

Provides methods for initializing the resources needed by vocabularies stored in a Solr index.

Since:

1.2M4 (under different names since 1.0M10)

Version:

$Id: 5e96241b7dcae4cfd1e299000a52b0c2f1ccfbeb $

Method Summary

Modifier and Type	Method and Description
void	createReplacementCore(Vocabulary vocabulary) Copy the Solr configuration file in a separate temporary directory, then register this temporary core with the Solr server.
void	discardReplacementCore(Vocabulary vocabulary) Delete the temporary core, if one was already created by createReplacementCore(Vocabulary).
org.apache.solr.client.solrj.SolrClient	getReplacementSolrConnection(Vocabulary vocabulary) Get the temporary Solr core used for a vocabulary during reindexing.
org.apache.solr.client.solrj.SolrClient	getSolrConnection(Vocabulary vocabulary) Get the Solr core used for a vocabulary.
org.xwiki.cache.Cache<VocabularyTerm>	getTermCache(Vocabulary vocabulary) Get the cache instance created for handling vocabulary terms.
void	replaceCore(Vocabulary vocabulary) Copy new index data from the temporary core to the main index location.

Method Detail

getTermCache

org.xwiki.cache.Cache<VocabularyTerm> getTermCache(Vocabulary vocabulary)

Get the cache instance created for handling vocabulary terms.

Parameters:

vocabulary - the target vocabulary

Returns:

a cache instance

getSolrConnection

org.apache.solr.client.solrj.SolrClient getSolrConnection(Vocabulary vocabulary)

Get the Solr core used for a vocabulary.

Parameters:

vocabulary - the target vocabulary

Returns:

a Solr client for communication with the target core

createReplacementCore

void createReplacementCore(Vocabulary vocabulary)
                    throws org.xwiki.component.phase.InitializationException

Copy the Solr configuration file in a separate temporary directory, then register this temporary core with the Solr server. This core can be accessed with getReplacementSolrConnection(Vocabulary) during reindexing, and then it can either be discarded with discardReplacementCore(Vocabulary), or take the place of the official vocabulary index with replaceCore(Vocabulary).

Parameters:

vocabulary - the target vocabulary

Throws:

org.xwiki.component.phase.InitializationException - if the process fails

Since:

1.4

replaceCore

void replaceCore(Vocabulary vocabulary)
          throws org.xwiki.component.phase.InitializationException

Copy new index data from the temporary core to the main index location.

Parameters:

vocabulary - the target vocabulary

Throws:

org.xwiki.component.phase.InitializationException - if the process fails

Since:

1.4

getReplacementSolrConnection

org.apache.solr.client.solrj.SolrClient getReplacementSolrConnection(Vocabulary vocabulary)

Get the temporary Solr core used for a vocabulary during reindexing.

Parameters:

vocabulary - the identifier of the target vocabulary

Returns:

a Solr client for communication with the target temporary core

Since:

1.4

discardReplacementCore

void discardReplacementCore(Vocabulary vocabulary)

Delete the temporary core, if one was already created by createReplacementCore(Vocabulary). If no temporary core was created, nothing happens.

Parameters:

vocabulary - the target vocabulary

Since:

1.4