RecordColumnEntryQueryPart.java

/*
 * Copyright (c) 2002-2018, 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.directory.modules.multiview.business.record.column.querypart.impl;

import java.util.Arrays;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;

import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn;
import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.impl.RecordColumnEntry;
import fr.paris.lutece.plugins.directory.modules.multiview.util.RecordEntryNameConstants;
import fr.paris.lutece.util.sql.DAOUtil;

/**
 * Implementation of the IRecordColumnQueryPart interface for an Entry column
 */
public class RecordColumnEntryQueryPart extends AbstractRecordColumnQueryPart
{
    // Constants
    private static final String ENTRY_SELECT_QUERY_PART = "GROUP_CONCAT( DISTINCT column_%1$s.column_%1$s_value SEPARATOR ',') AS column_%1$s_value ";
    private static final String ENTRY_FROM_QUERY_PART = StringUtils.EMPTY;
    private static final String ENTRY_JOIN_SELECT_QUERY_PART = "LEFT JOIN ( SELECT record_%1$s.id_record AS id_record_%1$s, record_field_%1$s.record_field_value AS column_%1$s_value ";
    private static final String ENTRY_JOIN_FROM_QUERY_PART = " FROM directory_record_field AS record_field_%s ";
    private static final String ENTRY_JOIN_RECORD_QUERY_PART = " INNER JOIN directory_record AS record_%1$s ON record_field_%1$s.id_record = record_%1$s.id_record ";
    private static final String ENTRY_JOIN_ENTRY_QUERY_PART = " INNER JOIN directory_entry AS entry_%1$s ON entry_%1$s.id_entry = record_field_%1$s.id_entry ";
    private static final String ENTRY_JOIN_WHERE_QUERY_PART = " WHERE entry_%1$s.title IN ( %2$s ) ";
    private static final String ENTRY_JOIN_QUERY_PART = " AS column_%1$s ON column_%1$s.id_record_%1$s = record.id_record";

    /**
     * {@inheritDoc}
     */
    @Override
    public String getRecordColumnSelectQuery( )
    {
        int nRecordColumnPosition = getRecordColumnPosition( );
        String strRecordColumnSelectQuery = String.format( ENTRY_SELECT_QUERY_PART, nRecordColumnPosition );

        return strRecordColumnSelectQuery;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getRecordColumnFromQuery( )
    {
        return ENTRY_FROM_QUERY_PART;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<String> getRecordColumnJoinQueries( )
    {
        int nRecordColumnPosition = getRecordColumnPosition( );

        StringBuilder stringBuilderJoinQuery = new StringBuilder( );

        String strJoinSelectQueryPart = String.format( ENTRY_JOIN_SELECT_QUERY_PART, nRecordColumnPosition );
        stringBuilderJoinQuery.append( strJoinSelectQueryPart );

        String strJoinFromQueryPart = String.format( ENTRY_JOIN_FROM_QUERY_PART, nRecordColumnPosition );
        stringBuilderJoinQuery.append( strJoinFromQueryPart );

        String strJoinInnerJoinRecordQueryPart = String.format( ENTRY_JOIN_RECORD_QUERY_PART, nRecordColumnPosition );
        stringBuilderJoinQuery.append( strJoinInnerJoinRecordQueryPart );

        String strJoinInnerJoinEntryQueryPart = String.format( ENTRY_JOIN_ENTRY_QUERY_PART, nRecordColumnPosition );
        stringBuilderJoinQuery.append( strJoinInnerJoinEntryQueryPart );

        StringBuilder stringBuilderListEntryTitle = new StringBuilder( );
        IRecordColumn recordColumn = getRecordColumn( );
        if ( recordColumn instanceof RecordColumnEntry )
        {
            RecordColumnEntry recordColumnEntry = (RecordColumnEntry) recordColumn;
            List<String> listEntryTitle = recordColumnEntry.getListEntryTitle( );
            if ( listEntryTitle != null && !listEntryTitle.isEmpty( ) )
            {
                buildListEntryTitle( stringBuilderListEntryTitle, listEntryTitle );
            }
        }

        String strJoinWhereQueryPart = String.format( ENTRY_JOIN_WHERE_QUERY_PART, nRecordColumnPosition, stringBuilderListEntryTitle.toString( ) );
        stringBuilderJoinQuery.append( strJoinWhereQueryPart ).append( " ) " );

        String strJoinQueryPart = String.format( ENTRY_JOIN_QUERY_PART, nRecordColumnPosition );
        stringBuilderJoinQuery.append( strJoinQueryPart );

        return Arrays.asList( stringBuilderJoinQuery.toString( ) );
    }

    /**
     * Build the list of all entry title from the given list quoting them and separate them by comma and after that append it to the given StringBuilder
     * 
     * @param stringBuilderListEntryTitle
     *            The StringBuilder to append the list of all entry title
     * @param listEntryTitle
     *            The list of entry title to manage
     */
    private void buildListEntryTitle( StringBuilder stringBuilderListEntryTitle, List<String> listEntryTitle )
    {
        Iterator<String> iteratorListEntryTitle = listEntryTitle.iterator( );
        while ( iteratorListEntryTitle.hasNext( ) )
        {
            String strEntryTitle = iteratorListEntryTitle.next( );
            stringBuilderListEntryTitle.append( '\'' ).append( strEntryTitle ).append( '\'' );

            if ( iteratorListEntryTitle.hasNext( ) )
            {
                stringBuilderListEntryTitle.append( ", " );
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected Map<String, Object> getMapRecordColumnValues( DAOUtil daoUtil )
    {
        int nRecordColumnPosition = getRecordColumnPosition( );
        Map<String, Object> mapRecordColumnValues = new LinkedHashMap<>( );
        String strEntryValueColumnName = String.format( RecordEntryNameConstants.COLUMN_ENTRY_VALUE_PATTERN, nRecordColumnPosition );
        mapRecordColumnValues.put( strEntryValueColumnName, daoUtil.getString( strEntryValueColumnName ) );

        return mapRecordColumnValues;
    }

    /**
     * Return the position of the RecordColumn or NumberUtils.INTEGER_MINUS_ONE if doesn't exist
     * 
     * @return the position of the RecordColumn
     */
    private int getRecordColumnPosition( )
    {
        int nRecordColumnPosition = NumberUtils.INTEGER_MINUS_ONE;
        IRecordColumn recordColumn = getRecordColumn( );
        if ( recordColumn != null )
        {
            nRecordColumnPosition = recordColumn.getRecordColumnPosition( );
        }

        return nRecordColumnPosition;
    }
}