com.communote.server.core.note.processor

Class NoteRenderingExtensionPoint

java.lang.Object

com.communote.server.core.note.processor.NoteRenderingExtensionPoint

All Implemented Interfaces:

NoteRenderingPreProcessorManager

@Service(value="noteRenderingPreProcessorManager")
public class NoteRenderingExtensionPoint
extends Object
implements NoteRenderingPreProcessorManager

Implementation of the note rendering preprocessor extension point.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
NoteRenderingExtensionPoint()

Method Summary

Modifier and Type	Method and Description
void	addProcessor(NoteContentRenderingPreProcessor processor) Adds the given processor to the list of processors.
void	addProcessor(NoteMetadataRenderingPreProcessor processor) Adds the given processor to the list of processors.
void	addProcessor(NoteMetadataRenderingPreProcessor processor, boolean runAfterContentProcessors) Adds the given processor to the list of processors.
NoteData	process(NoteRenderContext context, NoteData item) Processes a note by calling all the registered preprocessors which support the render mode of the context.
void	removeProcessor(NoteContentRenderingPreProcessor processor) Removes the given processor from the list of processors.
void	removeProcessor(NoteMetadataRenderingPreProcessor processor) Removes the given processor from the list of processors.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteRenderingExtensionPoint

public NoteRenderingExtensionPoint()

Method Detail

process

public NoteData process(NoteRenderContext context,
                        NoteData item)
                 throws NoteRenderingPreProcessorException

Description copied from interface: NoteRenderingPreProcessorManager

Processes a note by calling all the registered preprocessors which support the render mode of the context.

Specified by:

process in interface NoteRenderingPreProcessorManager

Parameters:

context - the render context. If the render context has no render mode (i.e. the render mode is null), no preprocessors will be called.

item - value object holding the details about the note

Returns:

the modified item

Throws:

NoteRenderingPreProcessorException - in case one of the preprocessors failed. When this exception is thrown the provided note list item can be in an inconsistent state (partially processed or might contain unexpected data). The caller should therefore ignore the provided note list item.

addProcessor

public void addProcessor(NoteContentRenderingPreProcessor processor)

Description copied from interface: NoteRenderingPreProcessorManager

Adds the given processor to the list of processors. The content preprocessors run after the metadata preprocessors.

Specified by:

addProcessor in interface NoteRenderingPreProcessorManager

Parameters:

processor - The processor to add.

addProcessor

public void addProcessor(NoteMetadataRenderingPreProcessor processor)

Description copied from interface: NoteRenderingPreProcessorManager

Adds the given processor to the list of processors. The metadata preprocessors run before the content preprocessors.

Specified by:

addProcessor in interface NoteRenderingPreProcessorManager

Parameters:

processor - The processor to add.

addProcessor

public void addProcessor(NoteMetadataRenderingPreProcessor processor,
                         boolean runAfterContentProcessors)

Description copied from interface: NoteRenderingPreProcessorManager

Adds the given processor to the list of processors.

Specified by:

addProcessor in interface NoteRenderingPreProcessorManager

Parameters:

processor - the processor to register

runAfterContentProcessors - if true the metadata preprocessor is invoked after the content preprocessors completed

removeProcessor

public void removeProcessor(NoteContentRenderingPreProcessor processor)

Description copied from interface: NoteRenderingPreProcessorManager

Removes the given processor from the list of processors.

Specified by:

removeProcessor in interface NoteRenderingPreProcessorManager

Parameters:

processor - The processor to remove

removeProcessor

public void removeProcessor(NoteMetadataRenderingPreProcessor processor)

Description copied from interface: NoteRenderingPreProcessorManager

Removes the given processor from the list of processors.

Specified by:

removeProcessor in interface NoteRenderingPreProcessorManager

Parameters:

processor - The processor to remove