org.broadleafcommerce.common.web.dialect

Class AbstractModelVariableModifierProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.element.AbstractElementProcessor

org.broadleafcommerce.common.web.dialect.AbstractModelVariableModifierProcessor

All Implemented Interfaces:

Comparable<org.thymeleaf.processor.IProcessor>, org.thymeleaf.processor.IProcessor

Direct Known Subclasses:

AdminModuleProcessor, AdminUserProcessor, BreadcrumbProcessor, CategoriesProcessor, ConfigVariableProcessor, ContentProcessor, DataDrivenEnumerationProcessor, GoogleAnalyticsProcessor, NamedOrderProcessor, ProductOptionsProcessor, RatingsProcessor, RelatedProductProcessor

public abstract class AbstractModelVariableModifierProcessor
extends org.thymeleaf.processor.element.AbstractElementProcessor

Author:

apazzolini Wrapper class around Thymeleaf's AbstractElementProcessor that facilitates adding Objects to the current evaluation context (model) for processing in the remainder of the page.

Constructor Summary

Constructors

Constructor and Description
AbstractModelVariableModifierProcessor(String elementName)

Method Summary

Modifier and Type	Method and Description
protected <T> void	addCollectionToExistingSet(org.thymeleaf.Arguments arguments, String key, Collection<T> value)
protected <T> void	addItemToExistingSet(org.thymeleaf.Arguments arguments, String key, Object value)
protected void	addToModel(org.thymeleaf.Arguments arguments, String key, Object value) Helper method to add a value to the expression evaluation root (model) Map
int	getPrecedence()
protected abstract void	modifyModelAttributes(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element) This method must be overriding by a processor that wishes to modify the model.
protected org.thymeleaf.processor.ProcessorResult	processElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element) This method will handle calling the modifyModelAttributes abstract method and return an "OK" processor result

Methods inherited from class org.thymeleaf.processor.element.AbstractElementProcessor

doProcess, getMatcher

Methods inherited from class org.thymeleaf.processor.AbstractProcessor

compareTo, getMessage, getMessageForProcessor, getMessageForTemplate, process

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModelVariableModifierProcessor

public AbstractModelVariableModifierProcessor(String elementName)

Method Detail

getPrecedence

public int getPrecedence()

Specified by:

getPrecedence in class org.thymeleaf.processor.AbstractProcessor

processElement

protected org.thymeleaf.processor.ProcessorResult processElement(org.thymeleaf.Arguments arguments,
                                                                 org.thymeleaf.dom.Element element)

This method will handle calling the modifyModelAttributes abstract method and return an "OK" processor result

Specified by:

processElement in class org.thymeleaf.processor.element.AbstractElementProcessor

addToModel

protected void addToModel(org.thymeleaf.Arguments arguments,
                          String key,
                          Object value)

Helper method to add a value to the expression evaluation root (model) Map

Parameters:

key - the key to add to the model

value - the value represented by the key

addCollectionToExistingSet

protected <T> void addCollectionToExistingSet(org.thymeleaf.Arguments arguments,
                                              String key,
                                              Collection<T> value)

addItemToExistingSet

protected <T> void addItemToExistingSet(org.thymeleaf.Arguments arguments,
                                        String key,
                                        Object value)

modifyModelAttributes

protected abstract void modifyModelAttributes(org.thymeleaf.Arguments arguments,
                                              org.thymeleaf.dom.Element element)

This method must be overriding by a processor that wishes to modify the model. It will be called by this abstract processor in the correct precendence in the evaluation chain.

Parameters:

arguments -

element -