Package org.ametys.plugins.extraction.component

Class MappingQueryExtractionComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.extraction.component.AbstractExtractionComponent

org.ametys.plugins.extraction.component.AbstractSolrExtractionComponent

org.ametys.plugins.extraction.component.MappingQueryExtractionComponent

All Implemented Interfaces:

ExtractionComponent, Configurable, LogEnabled, Serviceable

public class MappingQueryExtractionComponent
extends AbstractSolrExtractionComponent

This class represents a mapping query component of the extraction module

Field Summary

Fields inherited from class org.ametys.plugins.extraction.component.AbstractSolrExtractionComponent

_clauses, _contentTypes, _getQueryFromJSONHelper, _jsonUtils, _queryReferenceId

Fields inherited from class org.ametys.plugins.extraction.component.AbstractExtractionComponent

_contentTypeExtensionPoint, _contentTypesHelper, _subComponents, _tagName, _thesaurusDAO, EXTRACTION_ITEM_PATH_SEPARATOR, JOIN_HIERARCHY_ELEMENT, JOIN_HIERARCHY_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
MappingQueryExtractionComponent()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
Map<String,Object>	getComponentDetailsForTree()	Retrieves the details of the component for tree
protected String	getDefaultTagName()	Retrieves the default tag name
protected String	getLogsPrefix()	Retrieves the prefix to use in exceptions thrown by this component
protected void	processContents(Iterable<Content> contents, ContentHandler contentHandler, ExtractionExecutionContext context)	Process result contents to format the result document

Methods inherited from class org.ametys.plugins.extraction.component.AbstractSolrExtractionComponent

_getAttributeTypeId, addClauses, addContentTypes, computeReferencedQueryInfos, executeComponent, getClauses, getContents, getContentSearcher, getContentTypes, getQueryReferenceId, prepareComponentExecution, service, setQueryReferenceId

Methods inherited from class org.ametys.plugins.extraction.component.AbstractExtractionComponent

addSubComponent, execute, executeSubComponents, getSubComponents, getTagName, setTagName

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingQueryExtractionComponent

public MappingQueryExtractionComponent()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSolrExtractionComponent

Throws:

ConfigurationException

processContents

protected void processContents(Iterable<Content> contents,
                               ContentHandler contentHandler,
                               ExtractionExecutionContext context)
                        throws Exception

Description copied from class: AbstractSolrExtractionComponent

Process result contents to format the result document

Specified by:

processContents in class AbstractSolrExtractionComponent

Parameters:

contents - search results

contentHandler - result document

context - component execution context

Throws:

Exception - if an error occurs

getComponentDetailsForTree

public Map<String,Object> getComponentDetailsForTree()

Description copied from interface: ExtractionComponent

Retrieves the details of the component for tree

Specified by:

getComponentDetailsForTree in interface ExtractionComponent

Overrides:

getComponentDetailsForTree in class AbstractSolrExtractionComponent

Returns:

a Map containing component details

getDefaultTagName

protected String getDefaultTagName()

Description copied from class: AbstractExtractionComponent

Retrieves the default tag name

Specified by:

getDefaultTagName in class AbstractExtractionComponent

Returns:

the default tag name

getLogsPrefix

protected String getLogsPrefix()

Description copied from class: AbstractExtractionComponent

Retrieves the prefix to use in exceptions thrown by this component

Specified by:

getLogsPrefix in class AbstractExtractionComponent

Returns:

the prefix for exceptions