org.ametys.plugins.extraction.component

Interface TwoStepsExecutingExtractionComponent

All Superinterfaces:

ExtractionComponent

All Known Implementing Classes:

CountExtractionComponent, QueryExtractionComponent

public interface TwoStepsExecutingExtractionComponent
extends ExtractionComponent

ExtractionComponent whose execution sometimes needs to be done in two times (in order to avoid calling execute n times for performance reasons):

1. by computeFirstLevelResults(ExtractionExecutionContext) for returning all the first level content results;
2. by executeFor(ContentHandler, Iterable, ExtractionExecutionContext) for SAXing with the given ContentHandler and the given iterable on contents, subset of the one returned by the first method.

Thus, instead of calling execute n times, computeFirstLevelResults is called one time and executeFor is called n times with a different handler and iterable.

Important: The implementations must ensure that calling execute is equivalent to successively call computeFirstLevelResults and then executeFor with that result.

Method Summary

Modifier and Type	Method and Description
Iterable<Content>	computeFirstLevelResults(ExtractionExecutionContext context) Computes first level results for preparing multiple extraction executions
default void	execute(ContentHandler contentHandler, ExtractionExecutionContext context) Execute the extraction of the component
void	executeFor(ContentHandler contentHandler, Iterable<Content> subsetResults, ExtractionExecutionContext context) Execute the extraction of the component for the given first level results

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

addSubComponent, getComponentDetailsForTree, getContentTypes, getSubComponents, prepareComponentExecution

Method Detail

computeFirstLevelResults

Iterable<Content> computeFirstLevelResults(ExtractionExecutionContext context)
                                    throws Exception

Computes first level results for preparing multiple extraction executions

Parameters:

context - context of the extraction component

Returns:

The first level content results

Throws:

Exception - if an error occurs

executeFor

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

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

Parameters:

contentHandler - result document

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

context - context of the extraction component

Throws:

Exception - if an error occurs

execute

default void execute(ContentHandler contentHandler,
                     ExtractionExecutionContext context)
              throws Exception

Description copied from interface: ExtractionComponent

Execute the extraction of the component

Specified by:

execute in interface ExtractionComponent

Parameters:

contentHandler - result document

context - context of the extraction component

Throws:

Exception - if an error occurs