com.github.dandelion.datatables.thymeleaf.processor.AbstractTableAttrProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of datatables-thymeleaf Show documentation
There is a newer version: 1.1.0
/*
 * [The "BSD licence"]
 * Copyright (c) 2013-2014 Dandelion
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Dandelion nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.dandelion.datatables.thymeleaf.processor;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.thymeleaf.Arguments;
import org.thymeleaf.context.IWebContext;
import org.thymeleaf.dom.Element;
import org.thymeleaf.processor.IAttributeNameProcessorMatcher;
import org.thymeleaf.processor.ProcessorResult;
import org.thymeleaf.processor.attr.AbstractAttrProcessor;

import com.github.dandelion.datatables.core.configuration.ConfigToken;
import com.github.dandelion.datatables.thymeleaf.dialect.DataTablesDialect;

/**
 * Abstract superclass for all processors applied to the {@code table} tag.
 * 
 * @author Thibault Duchateau
 */
public abstract class AbstractTableAttrProcessor extends AbstractAttrProcessor {

	public AbstractTableAttrProcessor(IAttributeNameProcessorMatcher matcher) {
		super(matcher);
	}

	@Override
	@SuppressWarnings("unchecked")
	protected ProcessorResult processAttribute(Arguments arguments, Element element, String attributeName) {

		HttpServletRequest request = ((IWebContext) arguments.getContext()).getHttpServletRequest();
		Map, Object> stagingConf = (Map, Object>) request
				.getAttribute(DataTablesDialect.INTERNAL_BEAN_TABLE_STAGING_CONF);

		// Make the actual attribute processing
		doProcessAttribute(arguments, element, attributeName, stagingConf);

		// Housekeeping
		element.removeAttribute(attributeName);

		return ProcessorResult.ok();
	}

	/**
	 * Returns the precedence of the table attribute processor.
	 */
	@Override
	public abstract int getPrecedence();

	/**
	 * Actually performs the processing of the table attribute.
	 * 
	 * @param arguments
	 *            Thymeleaf arguments.
	 * @param element
	 *            Element holding the attribute to process.
	 * @param attributeName
	 *            Name of the attribute to process.
	 * @param stagingConf
	 *            Map containing the table local configuration.
	 */
	protected abstract void doProcessAttribute(Arguments arguments, Element element, String attributeName,
			Map, Object> stagingConf);
}