ExtractionComponent (Ametys 4.5.x - API)

All Known Subinterfaces:

TwoStepsExecutingExtractionComponent

All Known Implementing Classes:

AbstractExtractionComponent, AbstractGroupExtractionComponent, AbstractSolrExtractionComponent, CountExtractionComponent, MappingQueryExtractionComponent, QueryExtractionComponent, ThesaurusExtractionComponent
```
public interface ExtractionComponent
```
This interface represents a component of the extraction module

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addSubComponent(ExtractionComponent subComponent)`	Add sub component
`void`	`execute(ContentHandler contentHandler, ExtractionExecutionContext context)`	Execute the extraction of the component
`Map<String,Object>`	`getComponentDetailsForTree()`	Retrieves the details of the component for tree
`Set<String>`	`getContentTypes()`	Retrieves the list of content types defined for this component
`List<ExtractionComponent>`	`getSubComponents()`	Retrieves sub components of the component
`void`	`prepareComponentExecution(ExtractionExecutionContext context)`	Prepare the execution of the component

- Method Detail
  - prepareComponentExecution
```
void prepareComponentExecution(ExtractionExecutionContext context)
                        throws Exception
```
    Prepare the execution of the component
    
    Parameters:
    
    context - context of the extraction component
    
    Throws:
    
    Exception - if an error occurs
  - execute
```
void execute(ContentHandler contentHandler,
             ExtractionExecutionContext context)
      throws Exception
```
    Execute the extraction of the component
    
    Parameters:
    
    contentHandler - result document
    
    context - context of the extraction component
    
    Throws:
    
    Exception - if an error occurs
  - addSubComponent
```
void addSubComponent(ExtractionComponent subComponent)
```
    Add sub component
    
    Parameters:
    
    subComponent - the sub components to add
  - getSubComponents
```
List<ExtractionComponent> getSubComponents()
```
    Retrieves sub components of the component
    
    Returns:
    
    a list of sub components
  - getContentTypes
```
Set<String> getContentTypes()
```
    Retrieves the list of content types defined for this component
    
    Returns:
    
    a list of content types id
  - getComponentDetailsForTree
```
Map<String,Object> getComponentDetailsForTree()
```
    Retrieves the details of the component for tree
    
    Returns:
    
    a Map containing component details