org.ametys.web.tags.observers

Class AbstractTagObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.indexing.observation.AbstractLiveSolrObserver

org.ametys.web.tags.observers.AbstractTagObserver

All Implemented Interfaces:

Observer, LogEnabled, Contextualizable, Serviceable

Direct Known Subclasses:

TagAddedObserver, TagDeletedObserver, TagUpdatedObserver

public abstract class AbstractTagObserver
extends AbstractLiveSolrObserver

Abstract tag Observer

Field Summary

Fields

Modifier and Type	Field and Description
protected TagProviderExtensionPoint	_tagProviderEP The tag provider EP

Fields inherited from class org.ametys.web.indexing.observation.AbstractLiveSolrObserver

_context, _resolver, _solrIndexer, _solrPageIndexer

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractTagObserver()

Method Summary

Modifier and Type	Method and Description
protected void	_clearCache(Site site) Clear site cache
protected Site	_getSite(AmetysObject tagOrParent) Get the site of a jcr tag.
protected AmetysObjectIterable<Content>	_getTaggedContents(Collection<String> descendantNames) Re-index content tagged with at least of this tags
protected void	_updateIndex(Event event, Map<String,Object> transientVars) Update the index from the event observed.
protected abstract void	observe(Site site, AmetysObject tagOrParent, String tagName, Event rawEvent) Typed observe method
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.indexing.observation.AbstractLiveSolrObserver

_deletePageDocumentsForContent, _getPageInLive, _updatePageDocument, _updatePageDocument, _updatePageDocumentsForContent, contextualize, getPriority, observe

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

Methods inherited from interface org.ametys.core.observation.Observer

supports

Field Detail

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tag provider EP

Constructor Detail

AbstractTagObserver

public AbstractTagObserver()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractLiveSolrObserver

Throws:

ServiceException

_updateIndex

protected void _updateIndex(Event event,
                            Map<String,Object> transientVars)
                     throws Exception

Description copied from class: AbstractLiveSolrObserver

Update the index from the event observed.

Specified by:

_updateIndex in class AbstractLiveSolrObserver

Parameters:

event - the event.

transientVars - the transient vars passed from one Observer to another when processing a single Event.

Throws:

Exception - if an error occurs.

observe

protected abstract void observe(Site site,
                                AmetysObject tagOrParent,
                                String tagName,
                                Event rawEvent)

Typed observe method

Parameters:

site - the site

tagOrParent - the tag or its parent

tagName - the tag name corresponding the the object tagOrParent when applicable.

rawEvent - The raw event from which the previous arguments have been extracted.

_getSite

protected Site _getSite(AmetysObject tagOrParent)

Get the site of a jcr tag.

Parameters:

tagOrParent - Ametys object which can be a tag or its parent depending on the event type.

Returns:

The site

_clearCache

protected void _clearCache(Site site)

Clear site cache

Parameters:

site - the site

_getTaggedContents

protected AmetysObjectIterable<Content> _getTaggedContents(Collection<String> descendantNames)
                                                    throws Exception

Re-index content tagged with at least of this tags

Parameters:

descendantNames - the descendant tags' name

Returns:

iterable on contents

Throws:

Exception - if an error occurs