Package org.ametys.plugins.extraction.component

Class CountExtractionComponent

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.AbstractGroupExtractionComponent

org.ametys.plugins.extraction.component.CountExtractionComponent

All Implemented Interfaces:

ExtractionComponent, TwoStepsExecutingExtractionComponent, Configurable, LogEnabled, Serviceable

public class CountExtractionComponent
extends AbstractGroupExtractionComponent
implements TwoStepsExecutingExtractionComponent

This class represents a count component of the extraction module

Field Summary

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

_groupingFields

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
CountExtractionComponent()

Method Summary

Modifier and Type	Method	Description
void	addSubComponent(ExtractionComponent subComponent)	Add sub component
Iterable<Content>	computeFirstLevelResults(ExtractionExecutionContext context)	Computes first level results for preparing multiple extraction executions
void	executeFor(ContentHandler contentHandler, Iterable<Content> firstLevelResults, ExtractionExecutionContext context)	Execute the extraction of the component for the given first level results
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
protected void	saxContents(ContentHandler contentHandler, ExtractionExecutionContext context, ViewItemContainer resultItems, List<Content> contents)	Sax a content

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

addGroupingFields, configure, getGroupingFields, organizeContentsInGroups, prepareComponentExecution, saxGroup, service

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

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

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

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

Methods inherited from interface org.ametys.plugins.extraction.component.ExtractionComponent

getContentTypes, getSubComponents, prepareComponentExecution

Methods inherited from interface org.ametys.plugins.extraction.component.TwoStepsExecutingExtractionComponent

execute

Constructor Details

CountExtractionComponent

public CountExtractionComponent()

Method Details

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

computeFirstLevelResults

public Iterable<Content> computeFirstLevelResults(ExtractionExecutionContext context)
                                           throws Exception

Description copied from interface: TwoStepsExecutingExtractionComponent

Computes first level results for preparing multiple extraction executions

Specified by:

computeFirstLevelResults in interface TwoStepsExecutingExtractionComponent

Parameters:

context - context of the extraction component

Returns:

The first level content results

Throws:

Exception - if an error occurs

executeFor

public void executeFor(ContentHandler contentHandler,
 Iterable<Content> firstLevelResults,
 ExtractionExecutionContext context)
                throws Exception

Description copied from interface: TwoStepsExecutingExtractionComponent

Execute the extraction of the component for the given first level results

Specified by:

executeFor in interface TwoStepsExecutingExtractionComponent

Parameters:

contentHandler - result document

firstLevelResults - A subset of the first level content results previously returned by TwoStepsExecutingExtractionComponent.computeFirstLevelResults(ExtractionExecutionContext)

context - context of the extraction component

Throws:

Exception - if an error occurs

saxContents

protected void saxContents(ContentHandler contentHandler,
 ExtractionExecutionContext context,
 ViewItemContainer resultItems,
 List<Content> contents)
                    throws Exception

Description copied from class: AbstractGroupExtractionComponent

Sax a content

Specified by:

saxContents in class AbstractGroupExtractionComponent

Parameters:

contentHandler - result document

context - execution context

resultItems - result fields to sax

contents - contents to sax

Throws:

Exception - if an error occurs

addSubComponent

public void addSubComponent(ExtractionComponent subComponent)

Description copied from interface: ExtractionComponent

Add sub component

Specified by:

addSubComponent in interface ExtractionComponent

Overrides:

addSubComponent in class AbstractExtractionComponent

Parameters:

subComponent - the sub components to add

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 AbstractGroupExtractionComponent

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