Package org.xwiki.filter.instance.input

Class AbstractInstanceInputEventGenerator<F>

java.lang.Object

org.xwiki.filter.instance.input.AbstractInstanceInputEventGenerator<F>

Type Parameters:

F - the type of the filter declaring the events supported by this InstanceInputEventGenerator

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, WikiDocumentFilter, WikiFarmFilter, WikiFilter, WikiSpaceFilter, InstanceInputEventGenerator, org.xwiki.filter.instance.internal.InstanceFilter, org.xwiki.filter.UnknownFilter

public abstract class AbstractInstanceInputEventGenerator<F>
extends Object
implements InstanceInputEventGenerator, org.xwiki.component.phase.Initializable

Since:

6.2M1

Version:

$Id: 05ef82e0d6f46daaca543c7cff0ca3dc948c65c4 $

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityReference	currentReference
protected Stack<String>	currentSpaces
protected String	currentWiki
protected org.xwiki.filter.descriptor.FilterStreamDescriptor	descriptor
protected Object	filter
protected Map<String,Object>	properties
protected F	proxyFilter

Fields inherited from interface org.xwiki.filter.UnknownFilter

FILTER_ELEMENT_ID

Fields inherited from interface org.xwiki.filter.event.model.WikiDocumentFilter

LOG_DOCUMENT_CREATED, LOG_DOCUMENT_DELETED, LOG_DOCUMENT_ERROR, LOG_DOCUMENT_SKIPPED, LOG_DOCUMENT_UPDATED, PARAMETER_CONTENT, PARAMETER_CONTENT_AUTHOR, PARAMETER_CONTENT_DATE, PARAMETER_CONTENT_HTML, PARAMETER_CREATION_AUTHOR, PARAMETER_CREATION_DATE, PARAMETER_CUSTOMCLASS, PARAMETER_DEFAULTTEMPLATE, PARAMETER_HIDDEN, PARAMETER_LASTREVISION, PARAMETER_LOCALE, PARAMETER_PARENT, PARAMETER_REVISION_AUTHOR, PARAMETER_REVISION_COMMENT, PARAMETER_REVISION_DATE, PARAMETER_REVISION_EFFECTIVEMETADATA_AUTHOR, PARAMETER_REVISION_MINOR, PARAMETER_REVISION_ORIGINALMETADATA_AUTHOR, PARAMETER_SYNTAX, PARAMETER_TITLE, PARAMETER_VALIDATIONSCRIPT

Constructor Summary

Constructors

Constructor	Description
AbstractInstanceInputEventGenerator()

Method Summary

Modifier and Type	Method	Description
void	beginUnknwon(String id, org.xwiki.filter.FilterEventParameters parameters)
void	beginWiki(String name, org.xwiki.filter.FilterEventParameters parameters)
void	beginWikiDocument(String name, org.xwiki.filter.FilterEventParameters parameters)
void	beginWikiDocumentLocale(Locale locale, org.xwiki.filter.FilterEventParameters parameters)
void	beginWikiDocumentRevision(String version, org.xwiki.filter.FilterEventParameters parameters)
void	beginWikiFarm(org.xwiki.filter.FilterEventParameters parameters)
void	beginWikiSpace(String name, org.xwiki.filter.FilterEventParameters parameters)
void	endUnknwon(String id, org.xwiki.filter.FilterEventParameters parameters)
void	endWiki(String name, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiDocument(String name, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiDocumentLocale(Locale locale, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiDocumentRevision(String version, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiFarm(org.xwiki.filter.FilterEventParameters parameters)
void	endWikiSpace(String name, org.xwiki.filter.FilterEventParameters parameters)
org.xwiki.filter.descriptor.FilterStreamDescriptor	getDescriptor()
Collection<Class<?>>	getFilterInterfaces()
void	initialize()
void	onUnknwon(String id, org.xwiki.filter.FilterEventParameters parameters)
protected void	setDescriptor(org.xwiki.filter.descriptor.FilterStreamDescriptor descriptor)
void	setFilter(Object filter)
void	setProperties(Map<String,Object> properties)
void	setWikiDocumentParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the document.
void	setWikiFarmParameters(org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the farm.
void	setWikiParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the wiki.
void	setWikiSpaceParameters(String name, org.xwiki.filter.FilterEventParameters parameters)	Set custom parameter related to the space.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Map<String,Object> properties

filter

protected Object filter

proxyFilter

protected F proxyFilter

currentWiki

protected String currentWiki

currentSpaces

protected Stack<String> currentSpaces

currentReference

protected EntityReference currentReference

descriptor

protected org.xwiki.filter.descriptor.FilterStreamDescriptor descriptor

Constructor Detail

AbstractInstanceInputEventGenerator

public AbstractInstanceInputEventGenerator()

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Throws:

org.xwiki.component.phase.InitializationException

getDescriptor

public org.xwiki.filter.descriptor.FilterStreamDescriptor getDescriptor()

Specified by:

getDescriptor in interface InstanceInputEventGenerator

Returns:

The FilterStreamDescriptor describes a FilterStream and has the list of bean class parameters or properties.

setDescriptor

protected void setDescriptor(org.xwiki.filter.descriptor.FilterStreamDescriptor descriptor)

getFilterInterfaces

public Collection<Class<?>> getFilterInterfaces()
                                         throws org.xwiki.filter.FilterException

Specified by:

getFilterInterfaces in interface InstanceInputEventGenerator

Returns:

the filters supported by this stream factory

Throws:

org.xwiki.filter.FilterException - when failing to get filters interfaces

setWikiFarmParameters

public void setWikiFarmParameters(org.xwiki.filter.FilterEventParameters parameters)
                           throws org.xwiki.filter.FilterException

Description copied from interface: InstanceInputEventGenerator

Set custom parameter related to the farm.

Specified by:

setWikiFarmParameters in interface InstanceInputEventGenerator

Parameters:

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

setWikiParameters

public void setWikiParameters(String name,
                              org.xwiki.filter.FilterEventParameters parameters)
                       throws org.xwiki.filter.FilterException

Description copied from interface: InstanceInputEventGenerator

Set custom parameter related to the wiki.

Specified by:

setWikiParameters in interface InstanceInputEventGenerator

Parameters:

name - the name of wiki

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

setWikiSpaceParameters

public void setWikiSpaceParameters(String name,
                                   org.xwiki.filter.FilterEventParameters parameters)
                            throws org.xwiki.filter.FilterException

Description copied from interface: InstanceInputEventGenerator

Set custom parameter related to the space.

Specified by:

setWikiSpaceParameters in interface InstanceInputEventGenerator

Parameters:

name - the name of space

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

setWikiDocumentParameters

public void setWikiDocumentParameters(String name,
                                      org.xwiki.filter.FilterEventParameters parameters)
                               throws org.xwiki.filter.FilterException

Description copied from interface: InstanceInputEventGenerator

Set custom parameter related to the document.

Specified by:

setWikiDocumentParameters in interface InstanceInputEventGenerator

Parameters:

name - the name of document

parameters - the parameters to set

Throws:

org.xwiki.filter.FilterException - when failing to set parameters

setProperties

public void setProperties(Map<String,Object> properties)

Specified by:

setProperties in interface InstanceInputEventGenerator

Parameters:

properties - the event generator properties

setFilter

public void setFilter(Object filter)

Specified by:

setFilter in interface InstanceInputEventGenerator

Parameters:

filter - the filter to send events to

beginWikiFarm

public void beginWikiFarm(org.xwiki.filter.FilterEventParameters parameters)
                   throws org.xwiki.filter.FilterException

Specified by:

beginWikiFarm in interface WikiFarmFilter

Throws:

org.xwiki.filter.FilterException

endWikiFarm

public void endWikiFarm(org.xwiki.filter.FilterEventParameters parameters)
                 throws org.xwiki.filter.FilterException

Specified by:

endWikiFarm in interface WikiFarmFilter

Throws:

org.xwiki.filter.FilterException

beginWiki

public void beginWiki(String name,
                      org.xwiki.filter.FilterEventParameters parameters)
               throws org.xwiki.filter.FilterException

Specified by:

beginWiki in interface WikiFilter

Throws:

org.xwiki.filter.FilterException

endWiki

public void endWiki(String name,
                    org.xwiki.filter.FilterEventParameters parameters)
             throws org.xwiki.filter.FilterException

Specified by:

endWiki in interface WikiFilter

Throws:

org.xwiki.filter.FilterException

beginWikiSpace

public void beginWikiSpace(String name,
                           org.xwiki.filter.FilterEventParameters parameters)
                    throws org.xwiki.filter.FilterException

Specified by:

beginWikiSpace in interface WikiSpaceFilter

Throws:

org.xwiki.filter.FilterException

endWikiSpace

public void endWikiSpace(String name,
                         org.xwiki.filter.FilterEventParameters parameters)
                  throws org.xwiki.filter.FilterException

Specified by:

endWikiSpace in interface WikiSpaceFilter

Throws:

org.xwiki.filter.FilterException

beginWikiDocument

public void beginWikiDocument(String name,
                              org.xwiki.filter.FilterEventParameters parameters)
                       throws org.xwiki.filter.FilterException

Specified by:

beginWikiDocument in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

endWikiDocument

public void endWikiDocument(String name,
                            org.xwiki.filter.FilterEventParameters parameters)
                     throws org.xwiki.filter.FilterException

Specified by:

endWikiDocument in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

beginWikiDocumentLocale

public void beginWikiDocumentLocale(Locale locale,
                                    org.xwiki.filter.FilterEventParameters parameters)
                             throws org.xwiki.filter.FilterException

Specified by:

beginWikiDocumentLocale in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

endWikiDocumentLocale

public void endWikiDocumentLocale(Locale locale,
                                  org.xwiki.filter.FilterEventParameters parameters)
                           throws org.xwiki.filter.FilterException

Specified by:

endWikiDocumentLocale in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

beginWikiDocumentRevision

public void beginWikiDocumentRevision(String version,
                                      org.xwiki.filter.FilterEventParameters parameters)
                               throws org.xwiki.filter.FilterException

Specified by:

beginWikiDocumentRevision in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

endWikiDocumentRevision

public void endWikiDocumentRevision(String version,
                                    org.xwiki.filter.FilterEventParameters parameters)
                             throws org.xwiki.filter.FilterException

Specified by:

endWikiDocumentRevision in interface WikiDocumentFilter

Throws:

org.xwiki.filter.FilterException

beginUnknwon

public void beginUnknwon(String id,
                         org.xwiki.filter.FilterEventParameters parameters)
                  throws org.xwiki.filter.FilterException

Specified by:

beginUnknwon in interface org.xwiki.filter.UnknownFilter

Throws:

org.xwiki.filter.FilterException

endUnknwon

public void endUnknwon(String id,
                       org.xwiki.filter.FilterEventParameters parameters)
                throws org.xwiki.filter.FilterException

Specified by:

endUnknwon in interface org.xwiki.filter.UnknownFilter

Throws:

org.xwiki.filter.FilterException

onUnknwon

public void onUnknwon(String id,
                      org.xwiki.filter.FilterEventParameters parameters)
               throws org.xwiki.filter.FilterException

Specified by:

onUnknwon in interface org.xwiki.filter.UnknownFilter

Throws:

org.xwiki.filter.FilterException