Interface SolrIndexService
- All Known Implementing Classes:
DefaultSolrIndexService
public interface SolrIndexService
Service for managing indexes.
-
Method Summary
Modifier and TypeMethodDescriptionactivateIndex(String facetSearchConfig, String indexedType, String qualifier) Activates an index.createIndex(String facetSearchConfig, String indexedType, String qualifier) Creates an index.voiddeleteIndex(String facetSearchConfig, String indexedType, String qualifier) Deletes an index.getActiveIndex(String facetSearchConfig, String indexedType) Returns the active index for a specific facet search configuration and indexed type.Returns all indexes.Finds an index by facet search configuration, indexed type and qualifier.getIndexesForConfigAndType(String facetSearchConfig, String indexedType) Returns all indexes for a specific facet search configuration and indexed type.getOrCreateIndex(String facetSearchConfig, String indexedType, String qualifier) Gets or creates an index (if it does not exist yet).
-
Method Details
-
createIndex
SolrIndexModel createIndex(String facetSearchConfig, String indexedType, String qualifier) throws SolrServiceException Creates an index.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type namequalifier- - the qualifier- Returns:
- the index
- Throws:
SolrServiceException- if an error occurs
-
getAllIndexes
Returns all indexes.- Returns:
- the indexes
- Throws:
SolrServiceException- if an error occurs
-
getIndexesForConfigAndType
List<SolrIndexModel> getIndexesForConfigAndType(String facetSearchConfig, String indexedType) throws SolrServiceException Returns all indexes for a specific facet search configuration and indexed type.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type name- Returns:
- the indexes
- Throws:
SolrServiceException- if an error occurs
-
getIndex
SolrIndexModel getIndex(String facetSearchConfig, String indexedType, String qualifier) throws SolrServiceException Finds an index by facet search configuration, indexed type and qualifier.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type namequalifier- - the qualifier- Returns:
- the index
- Throws:
SolrIndexNotFoundException- if an index cannot be foundSolrServiceException- if an error occurs
-
getOrCreateIndex
SolrIndexModel getOrCreateIndex(String facetSearchConfig, String indexedType, String qualifier) throws SolrServiceException Gets or creates an index (if it does not exist yet).- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type namequalifier- - the qualifier- Returns:
- the index
- Throws:
SolrServiceException- if an error occurs
-
deleteIndex
void deleteIndex(String facetSearchConfig, String indexedType, String qualifier) throws SolrServiceException Deletes an index.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type namequalifier- - the qualifier- Throws:
SolrIndexNotFoundException- if an index cannot be foundSolrServiceException- if an error occurs
-
activateIndex
SolrIndexModel activateIndex(String facetSearchConfig, String indexedType, String qualifier) throws SolrServiceException Activates an index. All other indexes within facet search configuration and indexed type combination will be deactivated.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type namequalifier- - the qualifier- Returns:
- the active index
- Throws:
SolrIndexNotFoundException- if an index cannot be foundSolrServiceException- if an error occurs
-
getActiveIndex
SolrIndexModel getActiveIndex(String facetSearchConfig, String indexedType) throws SolrServiceException Returns the active index for a specific facet search configuration and indexed type.- Parameters:
facetSearchConfig- - the facet search configuration nameindexedType- - the indexed type name- Returns:
- the active index
- Throws:
SolrIndexNotFoundException- if an index cannot be foundSolrServiceException- if an error occurs
-