Package org.xwiki.filter.instance.input

Class AbstractEntityEventGenerator<E,F>

java.lang.Object

org.xwiki.filter.instance.input.AbstractEntityEventGenerator<E,F>

Type Parameters:

E - the type of the entity (XWikiDocument, BaseObject, BaseClass, etc.)

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

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, EntityEventGenerator<E>

public abstract class AbstractEntityEventGenerator<E,F>
extends Object
implements EntityEventGenerator<E>, org.xwiki.component.phase.Initializable

Since:

6.2M1

Version:

$Id: 035175dd379d2ccbac878c9bfc4dc50ab9cd4050 $

Field Summary

Fields

Modifier and Type	Field	Description
protected org.xwiki.filter.descriptor.FilterStreamDescriptor	descriptor
protected org.xwiki.filter.FilterDescriptorManager	filterDescriptorManager
protected Class<F>	filterType

Constructor Summary

Constructors

Constructor	Description
AbstractEntityEventGenerator()

Method Summary

Modifier and Type	Method	Description
org.xwiki.filter.descriptor.FilterStreamDescriptor	getDescriptor()
void	initialize()
protected void	setDescriptor(org.xwiki.filter.descriptor.FilterStreamDescriptor descriptor)
protected abstract void	write(E entity, Object filter, F internalFilter, Map<String,Object> properties)
void	write(E entity, Object filter, Map<String,Object> properties)

Methods inherited from class java.lang.Object

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

Field Detail

filterDescriptorManager

@Inject
protected org.xwiki.filter.FilterDescriptorManager filterDescriptorManager

filterType

protected Class<F> filterType

descriptor

protected org.xwiki.filter.descriptor.FilterStreamDescriptor descriptor

Constructor Detail

AbstractEntityEventGenerator

public AbstractEntityEventGenerator()

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 EntityEventGenerator<E>

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)

write

public void write(E entity,
                  Object filter,
                  Map<String,Object> properties)
           throws org.xwiki.filter.FilterException

Specified by:

write in interface EntityEventGenerator<E>

Throws:

org.xwiki.filter.FilterException

write

protected abstract void write(E entity,
                              Object filter,
                              F internalFilter,
                              Map<String,Object> properties)
                       throws org.xwiki.filter.FilterException

Throws:

org.xwiki.filter.FilterException