Classes

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

Class SolrMetadataExtractor

Class SolrMetadataExtractor	Line # 38	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.metadata;
21
22		import org.xwiki.component.annotation.Role;
23		import org.xwiki.model.reference.EntityReference;
24		import org.xwiki.search.solr.internal.api.SolrIndexerException;
25
26		/**
27		* Internal component interface for handling the extraction of metadata into a {@link SolrInputDocument} from XWiki
28		* entities reference. Each entity type is supported by a specific implementation so the correct implementation must be
29		* used with the correct entity type.
30		* <p>
31		* The implementation use as hint the same value as returned by something like
32		* {@code org.xwiki.model.EntityType.DOCUMENT.name().toLowerCase()} so they are easily retrievable, if they exist.
33		*
34		* @version $Id: 2615e3e20f3d96e76b0b36f536768709987a70ac $
35		* @since 4.3M2
36		*/
37		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
38		public interface SolrMetadataExtractor
39		{
40		/**
41		* Extract data from an XWiki entity and wrap it into a {@link SolrInputDocument} that is indexable by Solr.
42		*
43		* @param entityReference the reference to the entity.
44		* @return the {@link SolrInputDocument} containing the fields to be indexed for the entity.
45		* @throws SolrIndexerException if problems occur.
46		* @throws IllegalArgumentException if the passed reference is not supported by the current implementation.
47		*/
48		LengthSolrInputDocument getSolrDocument(EntityReference entityReference) throws SolrIndexerException,
49		IllegalArgumentException;
50		}