org.hdiv.web.servlet.support.HdivRequestDataValueProcessor.java Source code

Introduction

Here is the source code for org.hdiv.web.servlet.support.HdivRequestDataValueProcessor.java

Source

/**
 * Copyright 2005-2011 hdiv.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hdiv.web.servlet.support;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.hdiv.dataComposer.IDataComposer;
import org.hdiv.urlProcessor.FormUrlProcessor;
import org.hdiv.urlProcessor.LinkUrlProcessor;
import org.hdiv.util.Constants;
import org.hdiv.util.HDIVUtil;
import org.springframework.web.servlet.support.RequestDataValueProcessor;

/**
 * {@link RequestDataValueProcessor} implementation for HDIV.
 * 
 * @author Gotzon Illarramendi
 */
public class HdivRequestDataValueProcessor implements RequestDataValueProcessor {

    private LinkUrlProcessor linkUrlProcessor;

    private FormUrlProcessor formUrlProcessor;

    /**
     * No editable field types.
     */
    private List<String> noEditableTypes = new ArrayList<String>();

    public HdivRequestDataValueProcessor() {

        // Initialize no editable types list
        initNoEditableTypes();
    }

    /**
     * <p>
     * Initialize no editable input types.
     * </p>
     * <p>
     * Non editable input types:
     * <ul>
     * <li>checkbox</li>
     * <li>hidden</li>
     * <li>option</li>
     * <li>radio</li>
     * <li>select</li>
     * </ul>
     * </p>
     * <p>
     * Editable input types:
     * <ul>
     * <li>text</li>
     * <li>textarea</li>
     * <li>password</li>
     * <li>other input types: (number, tel, email...)</li>
     * </ul>
     * </p>
     */
    protected void initNoEditableTypes() {

        this.noEditableTypes.add("checkbox");
        this.noEditableTypes.add("hidden");
        this.noEditableTypes.add("option");
        this.noEditableTypes.add("radio");
        this.noEditableTypes.add("select");
    }

    /**
     * Process the action url of the form tag.
     * 
     * @param request
     *            request object
     * @param action
     *            form action url
     * @return processed action url
     */
    public String processAction(HttpServletRequest request, String action) {

        String result = this.formUrlProcessor.processUrl(request, action);
        return result;

    }

    /**
     * Process form field value.
     * 
     * @param request
     *            request object
     * @param name
     *            the name of the field
     * @param value
     *            the value of the field
     * @param type
     *            the type of the field
     * @return processed field value
     */
    public String processFormFieldValue(HttpServletRequest request, String name, String value, String type) {

        if (name == null) {
            return value;
        }

        IDataComposer dataComposer = (IDataComposer) request.getAttribute(HDIVUtil.DATACOMPOSER_REQUEST_KEY);

        if (dataComposer == null || dataComposer.isRequestStarted() == false) {
            return value;
        }

        if (isEditable(type)) {
            dataComposer.compose(name, value, true, type);
            return value;
        } else {
            String result = dataComposer.compose(name, value, false, type);
            return result;
        }

    }

    /**
     * Extra hidden fields with the HDIV state value.
     * 
     * @param request
     *            request object
     * @return hidden field name/value
     */
    public Map<String, String> getExtraHiddenFields(HttpServletRequest request) {

        IDataComposer dataComposer = (IDataComposer) request.getAttribute(HDIVUtil.DATACOMPOSER_REQUEST_KEY);
        Map<String, String> extraFields = new HashMap<String, String>();

        if (dataComposer == null || dataComposer.isRequestStarted() == false) {
            return extraFields;
        }

        String requestId = dataComposer.endRequest();

        if (requestId != null && requestId.length() > 0) {
            String hdivStateParam = (String) request.getSession().getAttribute(Constants.HDIV_PARAMETER);
            extraFields.put(hdivStateParam, requestId);
        }
        return extraFields;
    }

    /**
     * Process the url for a link.
     * 
     * @param request
     *            request object
     * @param url
     *            link url
     * @return processed url
     */
    public String processUrl(HttpServletRequest request, String url) {

        String result = this.linkUrlProcessor.processUrl(request, url);
        return result;
    }

    /**
     * Determines if a field type is editable or not.
     * 
     * @param type
     *            field type
     * @return editable
     */
    protected boolean isEditable(String type) {

        if (this.noEditableTypes.contains(type)) {
            return false;
        }
        return true;
    }

    /**
     * @param linkUrlProcessor
     *            the linkUrlProcessor to set
     */
    public void setLinkUrlProcessor(LinkUrlProcessor linkUrlProcessor) {
        this.linkUrlProcessor = linkUrlProcessor;
    }

    /**
     * @param formUrlProcessor
     *            the formUrlProcessor to set
     */
    public void setFormUrlProcessor(FormUrlProcessor formUrlProcessor) {
        this.formUrlProcessor = formUrlProcessor;
    }

}