org.ametys.plugins.extraction.component

Class ThesaurusExtractionComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.extraction.component.AbstractExtractionComponent

org.ametys.plugins.extraction.component.ThesaurusExtractionComponent

All Implemented Interfaces:

ExtractionComponent, Configurable, LogEnabled, Serviceable

public class ThesaurusExtractionComponent
extends AbstractExtractionComponent

This class represents a thesaurus component of the extraction module

Field Summary

Fields

Modifier and Type	Field and Description
private int	_maxLevel
private MicroThesaurus	_microThesaurus
private String	_microThesaurusName
private Thesaurus	_thesaurus
private String	_thesaurusName

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

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

Constructor Summary

Constructors

Constructor and Description
ThesaurusExtractionComponent()

Method Summary

Modifier and Type	Method and Description
private int	_getNbTermChildren(AmetysObjectIterable<AmetysObject> children)
private void	_processChildren(ContentHandler contentHandler, AmetysObjectIterable<AmetysObject> children, int currentLevel, ExtractionExecutionContext context)
void	configure(Configuration thesaurus)
void	executeComponent(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
protected String	getDefaultTagName() Retrieves the default tag name
protected String	getLogsPrefix() Retrieves the prefix to use in exceptions thrown by this component
int	getMaxLevel() Retrieves the maximum level of specific terms to look at
String	getMicroThesaurusName() Retrieves the component microthesaurus name
String	getThesaurusName() Retrieves the component thesaurus name
void	prepareComponentExecution(ExtractionExecutionContext context) Prepare the execution of the component
void	setMaxLevel(int maxLevel) Set the maximum level of specific terms to look at
void	setMicroThesaurusName(String thesaurusName) Set the microthesaurus name
void	setThesaurusName(String thesaurusName) Set the thesaurus name

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

addSubComponent, execute, executeSubComponents, getSubComponents, getTagName, service, 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

Field Detail

_thesaurusName

private String _thesaurusName

_microThesaurusName

private String _microThesaurusName

_maxLevel

private int _maxLevel

_thesaurus

private Thesaurus _thesaurus

_microThesaurus

private MicroThesaurus _microThesaurus

Constructor Detail

ThesaurusExtractionComponent

public ThesaurusExtractionComponent()

Method Detail

configure

public void configure(Configuration thesaurus)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractExtractionComponent

Throws:

ConfigurationException

prepareComponentExecution

public void prepareComponentExecution(ExtractionExecutionContext context)
                               throws Exception

Description copied from interface: ExtractionComponent

Prepare the execution of the component

Specified by:

prepareComponentExecution in interface ExtractionComponent

Overrides:

prepareComponentExecution in class AbstractExtractionComponent

Parameters:

context - context of the extraction component

Throws:

Exception - if an error occurs

executeComponent

public void executeComponent(ContentHandler contentHandler,
                             ExtractionExecutionContext context)
                      throws Exception

Description copied from class: AbstractExtractionComponent

Execute the extraction of the component

Specified by:

executeComponent in class AbstractExtractionComponent

Parameters:

contentHandler - result document

context - context of the extraction component

Throws:

Exception - if an error occurs

getContentTypes

public Set<String> getContentTypes()

Description copied from interface: ExtractionComponent

Retrieves the list of content types defined for this component

Returns:

a list of content types id

_processChildren

private void _processChildren(ContentHandler contentHandler,
                              AmetysObjectIterable<AmetysObject> children,
                              int currentLevel,
                              ExtractionExecutionContext context)
                       throws Exception

Throws:

Exception

_getNbTermChildren

private int _getNbTermChildren(AmetysObjectIterable<AmetysObject> children)

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 AbstractExtractionComponent

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

getThesaurusName

public String getThesaurusName()

Retrieves the component thesaurus name

Returns:

The thesaurus name

setThesaurusName

public void setThesaurusName(String thesaurusName)

Set the thesaurus name

Parameters:

thesaurusName - The thesaurus name to set

getMicroThesaurusName

public String getMicroThesaurusName()

Retrieves the component microthesaurus name

Returns:

The microthesaurus name

setMicroThesaurusName

public void setMicroThesaurusName(String thesaurusName)

Set the microthesaurus name

Parameters:

thesaurusName - The microthesaurus name to set

getMaxLevel

public int getMaxLevel()

Retrieves the maximum level of specific terms to look at

Returns:

The maximum level

setMaxLevel

public void setMaxLevel(int maxLevel)

Set the maximum level of specific terms to look at

Parameters:

maxLevel - The maximum level to set