com.communote.server.core.template

Class TemplateNoteRenderingPreProcessor

java.lang.Object

com.communote.server.core.template.TemplateNoteRenderingPreProcessor

All Implemented Interfaces:

Orderable, NoteContentRenderingPreProcessor

public class TemplateNoteRenderingPreProcessor
extends Object
implements NoteContentRenderingPreProcessor

RenderingPreProcessor which replaces the content of a template note with the result of the rendered template that is associated with that note. A template note is a note with a specific note property. The rendering will take the current render mode and locale into account.

Author:

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

Field Summary

Fields inherited from interface com.communote.server.api.core.note.processor.NoteContentRenderingPreProcessor

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
TemplateNoteRenderingPreProcessor()

Method Summary

Modifier and Type	Method and Description
int	getOrder()
boolean	isCachable()
boolean	processNoteContent(NoteRenderContext context, NoteData item) Processes the note content for a specific render context.
boolean	replacesContent() Denotes whether the pre-processor replaces the note content completely.
boolean	supports(NoteRenderMode mode, NoteData item) Whether the processor supports a specific render mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateNoteRenderingPreProcessor

public TemplateNoteRenderingPreProcessor()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Orderable

Specified by:

getOrder in interface NoteContentRenderingPreProcessor

Returns:

the order value which is interpreted as the priority of the pre-processor. The higher the priority, the earlier this processor will be called.

isCachable

public boolean isCachable()

Specified by:

isCachable in interface NoteContentRenderingPreProcessor

Returns:

whether the result can be cached. This method has to return false if this PreProcessor modifies the content in a way that depends on other NoteRenderContext attributes than the NoteRenderMode (e.g. locale, request attributes or modeOptions). This PreProcessor should not modify the note metadata (NoteData object) while processing the content if this method returns true because the PreProcessor will not be invoked if the processed content was cached.

processNoteContent

public boolean processNoteContent(NoteRenderContext context,
                                  NoteData item)
                           throws NoteRenderingPreProcessorException

Processes the note content for a specific render context. This method will only be called if the processor supports the mode given by the render context.

Specified by:

processNoteContent in interface NoteContentRenderingPreProcessor

Parameters:

context - holds details about the render context to allow specific processing in different situations

item - the note item to process

Returns:

true if the item was modified, false otherwise

Throws:

NoteRenderingPreProcessorException - in case something unexpected lead to the failure of the processor

replacesContent

public boolean replacesContent()

Description copied from interface: NoteContentRenderingPreProcessor

Denotes whether the pre-processor replaces the note content completely.

Specified by:

replacesContent in interface NoteContentRenderingPreProcessor

Returns:

true if the processor replaces the content and the shortened content completely. If the processor only modifies parts of the content or other members of the item, false should be returned. When replacing content the new content must match the render mode.

supports

public boolean supports(NoteRenderMode mode,
                        NoteData item)

Whether the processor supports a specific render mode. When returning true and the processor modifies or replaces the note content it must ensure that it only inserts text which matches the render mode, specifically the processor shouldn't insert HTML markup when called in PLAIN mode.

Specified by:

supports in interface NoteContentRenderingPreProcessor

Parameters:

mode - the note render mode, never null

item - the note to render. A pre-processor can use this parameter to decide based on note attributes whether the note content should be processed

Returns:

true if the mode can be handled by the processor, false otherwise