fr.paris.lutece.plugins.genericattributes.service.entrytype.AbstractEntryTypeSelectSQL.java Source code

Java tutorial

Introduction

Here is the source code for fr.paris.lutece.plugins.genericattributes.service.entrytype.AbstractEntryTypeSelectSQL.java

Source

/*
 * Copyright (c) 2002-2014, Mairie de Paris
 * 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
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDERS OR CONTRIBUTORS 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.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.genericattributes.service.entrytype;

import fr.paris.lutece.plugins.genericattributes.business.Entry;
import fr.paris.lutece.plugins.genericattributes.business.Field;
import fr.paris.lutece.plugins.genericattributes.business.GenericAttributeError;
import fr.paris.lutece.plugins.genericattributes.business.MandatoryError;
import fr.paris.lutece.plugins.genericattributes.business.Response;
import fr.paris.lutece.plugins.genericattributes.util.GenericAttributesUtils;
import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.service.message.AdminMessage;
import fr.paris.lutece.portal.service.message.AdminMessageService;
import fr.paris.lutece.portal.service.util.AppException;
import fr.paris.lutece.util.sql.DAOUtil;

import org.apache.commons.lang.StringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import javax.servlet.http.HttpServletRequest;

/**
 * Abstract entry type for selects that take values from SQL requests
 */
public abstract class AbstractEntryTypeSelectSQL extends EntryTypeService {
    /**
     * {@inheritDoc}
     */
    @Override
    public String getRequestData(Entry entry, HttpServletRequest request, Locale locale) {
        String strTitle = request.getParameter(PARAMETER_TITLE);
        String strCode = request.getParameter(PARAMETER_ENTRY_CODE);
        String strHelpMessage = (request.getParameter(PARAMETER_HELP_MESSAGE) != null)
                ? request.getParameter(PARAMETER_HELP_MESSAGE).trim()
                : null;
        String strComment = request.getParameter(PARAMETER_COMMENT);
        String strMandatory = request.getParameter(PARAMETER_MANDATORY);
        String strCSSClass = request.getParameter(PARAMETER_CSS_CLASS);

        String strFieldError = StringUtils.EMPTY;

        if (StringUtils.isBlank(strTitle)) {
            strFieldError = FIELD_TITLE;
        }

        if (StringUtils.isNotBlank(strFieldError)) {
            Object[] tabRequiredFields = { I18nService.getLocalizedString(strFieldError, locale) };

            return AdminMessageService.getMessageUrl(request, MESSAGE_MANDATORY_FIELD, tabRequiredFields,
                    AdminMessage.TYPE_STOP);
        }

        // for don't update fields listFields=null
        entry.setFields(null);
        entry.setCode(strCode);
        entry.setTitle(strTitle);
        entry.setHelpMessage(strHelpMessage);
        entry.setComment(strComment);
        entry.setCSSClass(strCSSClass);

        entry.setMandatory(strMandatory != null);

        try {
            getSqlQueryFields(entry);
        } catch (AppException ae) {
            String strErrorMsg = ae.getMessage();

            if ((strErrorMsg != null) && strErrorMsg.contains(System.getProperty("line.separator"))) {
                strErrorMsg = strErrorMsg.substring(0, strErrorMsg.indexOf(System.getProperty("line.separator")));
            }

            Object[] tabErrorSQLMsg = { strErrorMsg };

            return AdminMessageService.getMessageUrl(request, MESSAGE_INVALID_SQL_QUERY, tabErrorSQLMsg,
                    AdminMessage.TYPE_STOP);
        }

        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public GenericAttributeError getResponseData(Entry entry, HttpServletRequest request,
            List<Response> listResponse, Locale locale) {
        String strIdField = request.getParameter(PREFIX_ATTRIBUTE + entry.getIdEntry());
        int nIdField = -1;
        Field field = null;
        Response response = new Response();
        response.setEntry(entry);

        if (StringUtils.isNotEmpty(strIdField) && StringUtils.isNumeric(strIdField)) {
            nIdField = Integer.parseInt(strIdField);
        }

        if (nIdField != -1) {
            field = GenericAttributesUtils.findFieldByIdInTheList(nIdField, getSqlQueryFields(entry));
        }

        if (field != null) {
            response.setResponseValue(field.getValue());
            response.setField(field);
        }

        listResponse.add(response);

        if (entry.isMandatory()) {
            if ((field == null) || StringUtils.isBlank(field.getValue())) {
                return new MandatoryError(entry, locale);
            }
        }

        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getResponseValueForExport(Entry entry, HttpServletRequest request, Response response,
            Locale locale) {
        return response.getResponseValue();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getResponseValueForRecap(Entry entry, HttpServletRequest request, Response response,
            Locale locale) {
        return (response.getField() != null) ? response.getField().getTitle() : StringUtils.EMPTY;
    }

    /**
     * Return fields from a SQL query
     * @param entry The entry
     * @return A list of fields
     */
    protected List<Field> getSqlQueryFields(Entry entry) {
        List<Field> list = new ArrayList<Field>();
        String strSQL = entry.getComment();
        DAOUtil daoUtil = new DAOUtil(strSQL, GenericAttributesUtils.getPlugin());
        daoUtil.executeQuery();

        while (daoUtil.next()) {
            Field field = new Field();
            field.setIdField(daoUtil.getInt(1));
            field.setTitle(daoUtil.getString(2));
            field.setValue(field.getTitle());
            list.add(field);
        }

        daoUtil.free();

        return list;
    }
}