AbstractRecordColumnQueryPart.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.LinkedHashMap;
import java.util.List;
import java.util.Map;

import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn;
import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.RecordColumnCell;
import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.querypart.IRecordColumnQueryPart;
import fr.paris.lutece.util.sql.DAOUtil;

/**
 * Abstract class for RecordColumnQueryPart
 */
public abstract class AbstractRecordColumnQueryPart implements IRecordColumnQueryPart
{
    // Variables
    private IRecordColumn _recordColumn;

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract String getRecordColumnSelectQuery( );

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

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract List<String> getRecordColumnJoinQueries( );

    /**
     * Build the map of RecordColumnValues for the Record column of the query part
     * 
     * @param daoUtil
     *            The daoUtil to use to retrieve the data of the record column
     * @return the map of RecordColumnValues for the Record column of the query part
     */
    protected abstract Map<String, Object> getMapRecordColumnValues( DAOUtil daoUtil );

    /**
     * {@inheritDoc}
     */
    @Override
    public void setRecordColumn( IRecordColumn recordColumn )
    {
        _recordColumn = recordColumn;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public IRecordColumn getRecordColumn( )
    {
        return _recordColumn;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public RecordColumnCell getRecordColumnCell( DAOUtil daoUtil )
    {
        Map<String, Object> mapRecordColumnValues = new LinkedHashMap<>( );

        IRecordColumn recordColumn = getRecordColumn( );
        if ( recordColumn != null )
        {
            mapRecordColumnValues = getMapRecordColumnValues( daoUtil );
        }

        RecordColumnCell recordColumnCell = new RecordColumnCell( );
        recordColumnCell.setRecordColumnCellValues( mapRecordColumnValues );

        return recordColumnCell;
    }
}