org.acmsl.queryj.customsql.handlers.customsqlvalidation.ReportUnusedPropertiesHandler.java Source code

Introduction

Here is the source code for org.acmsl.queryj.customsql.handlers.customsqlvalidation.ReportUnusedPropertiesHandler.java

Source

/*
                    QueryJ Core
    
Copyright (C) 2002-today  Jose San Leandro Armendariz
                          chous@acm-sl.org
    
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or any later version.
    
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
    
You should have received a copy of the GNU General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    
Thanks to ACM S.L. for distributing this library under the GPL license.
Contact info: jose.sanleandro@acm-sl.com
    
 ******************************************************************************
 *
 * Filename: ReportUnusedPropertiesHandler.java
 *
 * Author: Jose San Leandro Armendariz
 *
 * Description: Detects and reports any unused properties (declared but not
 *              available in the ResultSet.
 *
 * Date: 2014/03/16
 * Time: 13:10
 *
 */
package org.acmsl.queryj.customsql.handlers.customsqlvalidation;

/*
 * Importing ACM SL Java Commons classes.
 */
import org.acmsl.commons.logging.UniqueLogFactory;

/*
 * Importing QueryJ Core classes.
 */
import org.acmsl.queryj.QueryJCommand;
import org.acmsl.queryj.api.exceptions.QueryJBuildException;
import org.acmsl.queryj.customsql.Property;
import org.acmsl.queryj.customsql.Sql;
import org.acmsl.queryj.tools.handlers.AbstractQueryJCommandHandler;

/*
 * Importing Apache Commons Logging classes.
 */
import org.apache.commons.logging.Log;

/*
 * Importing JetBrains annotations.
 */
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/*
 * Importing checkthread.org annotations.
 */
import org.checkthread.annotations.ThreadSafe;

/*
 * Importing JDK classes.
 */
import java.util.List;

/**
 * Detects and reports any unused properties (declared but not available
 * in the {@link java.sql.ResultSet}.
 * @author <a href="mailto:queryj@acm-sl.org">Jose San Leandro</a>
 * @since 3.0
 * Created: 2014/03/16 13:10
 */
@ThreadSafe
public class ReportUnusedPropertiesHandler extends AbstractQueryJCommandHandler {
    /**
     * Asks the handler to process the command. The idea is that each
     * command handler decides if such command is suitable of being
     * processed, and if so perform the concrete actions the command
     * represents.
     *
     * @param command the command to process (or not).
     * @return <code>true</code> if the handler actually process the command,
     *         or maybe because it's not desirable to continue the chain.
     */
    @Override
    public boolean handle(@NotNull final QueryJCommand command) throws QueryJBuildException {
        @NotNull
        final List<Property<String>> t_lProperties = new RetrieveResultPropertiesHandler()
                .retrieveCurrentProperties(command);

        @NotNull
        final List<Property<String>> t_lColumns = new RetrieveResultSetColumnsHandler()
                .retrieveCurrentColumns(command);

        @NotNull
        final Sql<String> t_Sql = new RetrieveQueryHandler().retrieveCurrentSql(command);

        @Nullable
        final Log t_Log = retrieveLog();

        diagnoseUnusedProperties(t_lProperties, t_lColumns, t_Sql, t_Log);

        return false;
    }

    /**
     * Retrieves the log.
     * @return such instance.
     */
    @Nullable
    protected Log retrieveLog() {
        return UniqueLogFactory.getLog(ReportMissingPropertiesHandler.class);
    }

    /**
     * Reports any unused property.
     * @param properties the declared properties.
     * @param columns the properties from the result set.
     * @param sql the query itself.
     * @param log the {@link Log}.
     */
    protected void diagnoseUnusedProperties(@NotNull final List<Property<String>> properties,
            @NotNull final List<Property<String>> columns, @NotNull final Sql<String> sql,
            @Nullable final Log log) {
        if (log != null) {
            @NotNull
            final List<Property<String>> t_lExtraProperties = detectExtraProperties(properties, columns);

            int t_iIndex = 1;

            for (@Nullable
            final Property<String> t_ExtraProperty : t_lExtraProperties) {
                if (t_ExtraProperty != null) {
                    log.warn("Column declared but not used (" + t_iIndex + ", " + t_ExtraProperty.getColumnName()
                            + ", " + t_ExtraProperty.getType() + "), in sql " + sql.getId());
                }

                t_iIndex++;
            }
        }
    }

    /**
     * Detects any extra properties not declared in the query itself.
     * @param properties the declared properties.
     * @param resultSetProperties the properties actually exported by the query.
     * @return any extra property.
     */
    @NotNull
    protected List<Property<String>> detectExtraProperties(@NotNull final List<Property<String>> properties,
            @NotNull final List<Property<String>> resultSetProperties) {
        return new ReportMissingPropertiesHandler().detectMissingProperties(resultSetProperties, properties);
    }
}