DistributionMapEntryPoint.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale 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 Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squaleweb.gwt.distributionmap.client;

import org.squale.gwt.distributionmap.widget.DistributionMap;

import com.google.gwt.core.client.EntryPoint;
import com.google.gwt.core.client.GWT;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.RootPanel;

/**
 * Entry point for the Distribution Map displayed on the practice result page.
 * 
 * @author Fabrice BELLINGARD
 */
public class DistributionMapEntryPoint
    implements EntryPoint
{

    /**
     * Service used to retrieve the data to display
     */
    private final DataServiceAsync dataService = GWT.create( DataService.class );

    /**
     * The Distribution Map widget
     */
    private final DistributionMap dmWidget = new DistributionMap();

    /**
     * Parameter that identifies the practice to display
     */
    private long practiceId;

    /**
     * Parameter that identifies the project for which we want to display the DMap
     */
    private long projectId;

    /**
     * Parameter that identifies the audit for which we want to display the DMap
     */
    private long auditId;

    /**
     * Parameter that identifies the previous audit for which we want to display the DMap (needed to build the URL that
     * links the DMap boxes to the components)
     */
    private String previousAuditId;

    /**
     * ${@inheritDoc}
     * 
     * @see EntryPoint#onModuleLoad()
     */
    public void onModuleLoad()
    {
        boolean paramsOK = retrieveParamsFromURL();
        if ( paramsOK )
        {
            initDistributionMap();
            populateDistributionMap();
        }
        else
        {
            dmWidget.displayErrorMessage();
        }
        RootPanel.get( "distributionmap" ).add( dmWidget );
    }

    /**
     * Calls the RPC service to get the data to display
     */
    private void populateDistributionMap()
    {
        dmWidget.startLoading();
        dataService.getData( auditId, projectId, practiceId, dmWidget.getCallback() );
    }

    /**
     * Initializes the DMap
     */
    private void initDistributionMap()
    {
        // build the URL that is needed to display the component details
        StringBuffer detailURL = new StringBuffer( "project_component.do?action=component&projectId=" );
        detailURL.append( projectId );
        detailURL.append( "¤tAuditId=" );
        detailURL.append( auditId );
        detailURL.append( "&previousAuditId=" );
        detailURL.append( previousAuditId );
        detailURL.append( "&fromMarkPage=true&component=" );
        // set this URL to the DM widget
        dmWidget.setDetailURL( detailURL.toString() );
        // and tell the DMap to optimize the space
        dmWidget.setLayoutOptimized( true );
    }

    /**
     * Retrieves request parameters form the URL to pass them to the DMap Widget
     * 
     * @return true if the mandatory parameters are all successfully retrieved
     */
    private boolean retrieveParamsFromURL()
    {
        Boolean paramsOK;

        String stringAuditId = Window.Location.getParameter( "currentAuditId" );
        String stringProjectId = Window.Location.getParameter( "projectId" );
        String stringPracticeId = Window.Location.getParameter( "which" );
        if ( stringAuditId == null || stringAuditId.length() == 0 || stringProjectId == null
            || stringProjectId.length() == 0 || stringPracticeId == null || stringPracticeId.length() == 0 )
        {
            paramsOK = false;
        }
        else
        {
            auditId = Long.parseLong( stringAuditId );
            projectId = Long.parseLong( stringProjectId );
            practiceId = Long.parseLong( stringPracticeId );

            // ok for the mandatory params
            paramsOK = true;

            // optional parameter that does not need to be translated into a long
            previousAuditId = ""; // default value
            previousAuditId = Window.Location.getParameter( "previousAuditId" ); // correct value if it exists
        }

        return paramsOK;
    }

}