Package org.ametys.cms.duplicate.contents

Class DuplicateContentsManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.duplicate.contents.DuplicateContentsManager

All Implemented Interfaces:

LogEnabled, Component, Configurable, Serviceable

Direct Known Subclasses:

DuplicateContentsManager

public class DuplicateContentsManager
extends AbstractLogEnabled
implements Component, Serviceable, Configurable

Component able to detect duplicates (and near duplicates) for a given content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DuplicateContentsManager.Status	The status of the query

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentHelper	_contentHelper	The content helper
protected ContentSearcherFactory	_contentSearcherFactory	The content searcher factory.
protected DuplicateContentConfiguration	_duplicateContentConfiguration	The duplicate content description
static String	DUPLICATE_CONTENTS_KEY	key for duplicate contents list
static String	NEAR_DUPLICATE_CONTENTS_KEY	key for near duplicate contents list
static String	NO_DUPLICATE_CONTENTS_CONTENT_TYPE_KEY	key for boolean to know whether there are some content types or not
static String	ROLE	The component role.
static String	STATUS_KEY	key for boolean to know the query status

Constructor Summary

Constructors

Constructor	Description
DuplicateContentsManager()

Method Summary

Modifier and Type	Method	Description
protected Set<String>	_addDuplicatesContentTypes(String[] contentTypeIds)	Get the configured duplicates content types
protected List<Pair<String,List<Object>>>	_getConfigurationErrors()	Get the list of configuration errors
protected List<Pair<String,List<Object>>>	_getConfigurationWarns()	Get the list of configuration warns
protected AmetysObjectIterable<Content>	_getContents(Collection<String> contentTypes)	Retrieves indexed contents that have at least one of the listed content types
protected List<Content>	_getDuplicates(Content content, Set<DuplicateContentTypeConfiguration> duplicateContentTypeConfigurations, boolean nearDuplicates, String[] contentTypes)	Get the list of duplicates
protected List<Query>	_getDuplicatesQueries(Content content, Set<DuplicateContentTypeConfiguration> duplicateContentTypeConfigurations, boolean nearDuplicates, String[] contentTypes)	Get the list of queries to search for duplicates
void	configure(Configuration configuration)
Set<String>	getContentTypeIds()	Get the content types set
boolean	hasConfigurationErrors()	Returns true if there is at least one configuration error
void	logConfigurationErrors(org.slf4j.Logger logger)	Log all errors of the configuration
Map<String,Object>	searchDuplicates()	Get the data about duplicates and near duplicates for all contents that match the content types included in the configuration
Map<String,Object>	searchDuplicates(Iterable<Content> contents)	Get the data about duplicates and near duplicates for a list of contents
Map<String,Object>	searchDuplicates(Content content)	Get the data about duplicates and near duplicated for a given content
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The component role.

DUPLICATE_CONTENTS_KEY

public static final String DUPLICATE_CONTENTS_KEY

key for duplicate contents list

See Also:

Constant Field Values

NEAR_DUPLICATE_CONTENTS_KEY

public static final String NEAR_DUPLICATE_CONTENTS_KEY

key for near duplicate contents list

See Also:

Constant Field Values

NO_DUPLICATE_CONTENTS_CONTENT_TYPE_KEY

public static final String NO_DUPLICATE_CONTENTS_CONTENT_TYPE_KEY

key for boolean to know whether there are some content types or not

See Also:

Constant Field Values

STATUS_KEY

public static final String STATUS_KEY

key for boolean to know the query status

See Also:

Constant Field Values

_contentSearcherFactory

protected ContentSearcherFactory _contentSearcherFactory

The content searcher factory.

_contentHelper

protected ContentHelper _contentHelper

The content helper

_duplicateContentConfiguration

protected DuplicateContentConfiguration _duplicateContentConfiguration

The duplicate content description

Constructor Detail

DuplicateContentsManager

public DuplicateContentsManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

searchDuplicates

public Map<String,Object> searchDuplicates(Content content)

Get the data about duplicates and near duplicated for a given content

Parameters:

content - The content

Returns:

A map of data. key "duplicates" contains a list of the duplicates (id and label for each entry), and key "nearDuplicates" contains the near duplicates if requested (duplicates excluded).

searchDuplicates

public Map<String,Object> searchDuplicates()

Get the data about duplicates and near duplicates for all contents that match the content types included in the configuration

Returns:

the data about duplicates and near duplicates

searchDuplicates

public Map<String,Object> searchDuplicates(Iterable<Content> contents)

Get the data about duplicates and near duplicates for a list of contents

Parameters:

contents - the contents to check

Returns:

the data about duplicates and near duplicates

_getDuplicates

protected List<Content> _getDuplicates(Content content,
                                       Set<DuplicateContentTypeConfiguration> duplicateContentTypeConfigurations,
                                       boolean nearDuplicates,
                                       String[] contentTypes)
                                throws Exception

Get the list of duplicates

Parameters:

content - The content

duplicateContentTypeConfigurations - the attribute list

nearDuplicates - true to check for near duplicates

contentTypes - the content types

Returns:

list of duplicates

Throws:

Exception - if a problem occurs while searching for duplicates

_getDuplicatesQueries

protected List<Query> _getDuplicatesQueries(Content content,
                                            Set<DuplicateContentTypeConfiguration> duplicateContentTypeConfigurations,
                                            boolean nearDuplicates,
                                            String[] contentTypes)

Get the list of queries to search for duplicates

Parameters:

content - The content

duplicateContentTypeConfigurations - the attribute list

nearDuplicates - true to check for near duplicates

contentTypes - the content types

Returns:

list of duplicates

_addDuplicatesContentTypes

protected Set<String> _addDuplicatesContentTypes(String[] contentTypeIds)

Get the configured duplicates content types

Parameters:

contentTypeIds - The content type identifiers for which duplicates content types should be found

Returns:

the duplicate content types

_getContents

protected AmetysObjectIterable<Content> _getContents(Collection<String> contentTypes)

Retrieves indexed contents that have at least one of the listed content types

Parameters:

contentTypes - The desired content types

Returns:

solr query results

_getConfigurationErrors

protected List<Pair<String,List<Object>>> _getConfigurationErrors()

Get the list of configuration errors

Returns:

the configuration error list

_getConfigurationWarns

protected List<Pair<String,List<Object>>> _getConfigurationWarns()

Get the list of configuration warns

Returns:

the configuration warn list

getContentTypeIds

public Set<String> getContentTypeIds()

Get the content types set

Returns:

the content types set

logConfigurationErrors

public void logConfigurationErrors(org.slf4j.Logger logger)

Log all errors of the configuration

Parameters:

logger - the logger

hasConfigurationErrors

public boolean hasConfigurationErrors()

Returns true if there is at least one configuration error

Returns:

true if there is at least one configuration error