gov.nih.nci.cabig.caaers.tools.spring.tabbedflow.SimpleFormAjaxableController.java Source code

Introduction

Here is the source code for gov.nih.nci.cabig.caaers.tools.spring.tabbedflow.SimpleFormAjaxableController.java

Source

/*******************************************************************************
 * Copyright SemanticBits, Northwestern University and Akaza Research
 * 
 * Distributed under the OSI-approved BSD 3-Clause License.
 * See http://ncip.github.com/caaers/LICENSE.txt for details.
 ******************************************************************************/
package gov.nih.nci.cabig.caaers.tools.spring.tabbedflow;

import gov.nih.nci.cabig.caaers.dao.CaaersDao;
import gov.nih.nci.cabig.caaers.domain.AbstractMutableRetireableDomainObject;
import gov.nih.nci.cabig.caaers.domain.Retireable;
import gov.nih.nci.cabig.ctms.domain.AbstractMutableDomainObject;

import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.validation.Errors;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;

public abstract class SimpleFormAjaxableController<C extends AbstractMutableDomainObject, D extends AbstractMutableRetireableDomainObject, A extends CaaersDao<D>>
        extends SimpleFormController {

    private InPlaceEditableTab<C> page;

    protected abstract A getDao();

    public InPlaceEditableTab<C> getPage() {
        return page;
    }

    public SimpleFormAjaxableController() {
        super();
    }

    public void setPage(InPlaceEditableTab<C> page) {
        this.page = page;
    }

    @Override
    protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object command,
            BindException errors) throws Exception {
        // TODO Auto-generated method stub
        if (isAjaxRequest(request)) {
            request.getParameter("_asynchronous");
            ModelAndView modelAndView = page.postProcessAsynchronous(request, (C) command, errors);
            if (!errors.hasErrors() && shouldSave(request, (C) command)) {
                command = save((C) command, errors);
            }
            request.setAttribute(getFormSessionAttributeName(), command);
            if (isAjaxResponseFreeText(modelAndView)) {
                respondAjaxFreeText(modelAndView, response);
                return null;
            }
            return modelAndView;
        } else {
            return onSynchronousSubmit(request, response, (C) command, errors);
        }
    }

    protected ModelAndView onSynchronousSubmit(HttpServletRequest request, HttpServletResponse response,
            Object command, BindException errors) throws Exception {
        if (getSuccessView() == null) {
            throw new ServletException("successView isn't set");
        }
        return new ModelAndView(getSuccessView(), errors.getModel());
    }

    protected boolean isAjaxRequest(HttpServletRequest request) {
        return StringUtils.equalsIgnoreCase("true", request.getParameter(getAjaxRequestParamName()));
        /*
         if (StringUtils.getBlankIfNull(request.getParameter(getAjaxRequestParamName()))
                    .equalsIgnoreCase("true")) return true;
         return false;*/
    }

    protected void setAjaxModelAndView(HttpServletRequest request, ModelAndView modelAndView) {
        request.setAttribute(getAjaxModelAndViewAttr(), modelAndView);
    }

    protected ModelAndView getAjaxModelAndView(HttpServletRequest request) {
        return (ModelAndView) request.getAttribute(getAjaxModelAndViewAttr());
    }

    protected boolean isAjaxResponseFreeText(ModelAndView modelAndView) {
        return StringUtils.isEmpty(modelAndView.getViewName());

        /*if (StringUtils.getBlankIfNull(modelAndView.getViewName()).equals("")) {
        return true;
        }
        return false;*/
    }

    protected void respondAjaxFreeText(ModelAndView modelAndView, HttpServletResponse response) throws Exception {
        PrintWriter pr = response.getWriter();
        pr.println(modelAndView.getModel().get(getFreeTextModelName()));
        pr.flush();
        pr.close();
    }

    protected String getAjaxRequestParamName() {
        return "_asynchronous";
    }

    protected String getAjaxModelAndViewAttr() {
        return "async_model_and_view";
    }

    protected String getFreeTextModelName() {
        return "free_text";
    }

    protected ModelAndView postProcessAsynchronous(HttpServletRequest request, C command, Errors error)
            throws Exception {
        return new ModelAndView(getAjaxViewName(request));
    }

    protected String getAjaxViewName(HttpServletRequest request) {
        return request.getParameter(getAjaxViewParamName());
    }

    protected String getAjaxViewParamName() {
        return "_asyncViewName";
    }

    protected boolean shouldSave(HttpServletRequest request, C command) {
        return true;
    }

    protected C save(C command, BindException errors) {
        getDao().save(getPrimaryDomainObject(command));
        return command;
    }

    protected abstract D getPrimaryDomainObject(C command);
}