Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
SolrIndexer	36	0	-	0	0	-1.0 -	Show methods

Class SolrIndexer

Class SolrIndexer	Line # 36	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.search.solr.internal.api;
21
22		import org.xwiki.component.annotation.Role;
23		import org.xwiki.model.reference.EntityReference;
24		import org.xwiki.search.solr.internal.job.IndexerJob;
25		import org.xwiki.search.solr.internal.job.IndexerRequest;
26
27		/**
28		* Component that accepts XWiki {@link EntityReference}s to be indexed or deleted from the index if they exist. The
29		* references are expanded hierarchically, in the sense that all references beneath it will be processed as well. This
30		* is done to try to ensure consistency of the index.
31		*
32		* @version $Id: 0f1930859d05b3b03c88a1d730841add7af56091 $
33		* @since 5.1M2
34		*/
35		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
36		public interface SolrIndexer
37		{
38		/**
39		* Add an entity to the queue of entities to index.
40		* <p>
41		* Null reference means the whole farm.
42		*
43		* @param reference the entity's reference.
44		* @param recurse indicate if children entities should be indexed too
45		*/
46		void index(EntityReference reference, boolean recurse);
47
48		/**
49		* Add an entity to the queue of entities to delete.
50		* <p>
51		* Null reference means the whole farm.
52		*
53		* @param reference the entity's reference.
54		* @param recurse indicate if children entities should be removed too
55		*/
56		void delete(EntityReference reference, boolean recurse);
57
58		/**
59		* @return the number of element in the index/delete queue
60		*/
61		int getQueueSize();
62
63		/**
64		* Start an indexing with specific criteria.
65		*
66		* @param request the request to configure the indexing
67		* @return the created job to follow the progress
68		* @throws SolrIndexerException when failing to create the job
69		*/
70		IndexerJob startIndex(IndexerRequest request) throws SolrIndexerException;
71		}