AbstractProjectPresenter.java

package org.sigmah.client.ui.presenter.project;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * This program 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 3 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */


import org.sigmah.client.dispatch.CommandResultHandler;
import org.sigmah.client.inject.Injector;
import org.sigmah.client.page.Page;
import org.sigmah.client.page.PageRequest;
import org.sigmah.client.page.RequestParameter;
import org.sigmah.client.page.event.PageRequestEvent;
import org.sigmah.client.ui.presenter.base.AbstractPagePresenter;
import org.sigmah.client.ui.presenter.base.HasSubPresenter.SubPresenter;
import org.sigmah.client.ui.view.base.ViewInterface;
import org.sigmah.client.ui.zone.Zone;
import org.sigmah.shared.command.GetProject;
import org.sigmah.shared.dto.ProjectDTO;

import com.allen_sauer.gwt.log.client.Log;
import org.sigmah.client.i18n.I18N;
import org.sigmah.client.ui.notif.N10N;
import org.sigmah.shared.dispatch.NotCachedException;

/**
 * Project's presenters abstract code.<br/>
 * This super-class assumes that all inherited classes are a sub-presenter of {@link ProjectPresenter}. Can be changed
 * by overriding the {@link #getParentPresenter()} method.
 * 
 * @author Tom Miette (tmiette@ideia.fr)
 */
public abstract class AbstractProjectPresenter<V extends AbstractProjectPresenter.View> extends AbstractPagePresenter<V> implements
																																																												SubPresenter<ProjectPresenter> {

	/**
	 * Description of the view managed by this presenter.
	 */
	public static interface View extends ViewInterface {

		// No methods here yet.

	}

	/**
	 * Presenters's initialization.
	 * 
	 * @param view
	 *          Presenter's view interface.
	 * @param injector
	 *          Injected client injector.
	 */
	public AbstractProjectPresenter(final V view, final Injector injector) {
		super(view, injector);
	}
	
	/**
	 * Defines the loading mode of projects.
	 */
	private boolean useCache;

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected final void executeOnPageRequest(final PageRequestEvent event, final Page page) {

		final PageRequest request = event.getRequest();
		final Integer projectId = request.getParameterInteger(RequestParameter.ID);
		final Integer amendmentId = request.getParameterInteger(RequestParameter.VERSION);

		final ProjectDTO currentProject = getParentPresenter().getCurrentProject();

		if (useCache && currentProject != null && projectId.equals(currentProject.getId())) {
			if (Log.isDebugEnabled()) {
				Log.debug("Project #" + projectId + " has already been loaded. No need to load it again.");
			}
			onProjectLoaded(currentProject, event, page);
			
		} else {
			if (Log.isDebugEnabled()) {
				Log.debug("Project #" + projectId + " is not the current loaded project. Loading it from server.");
			}
			// Retrieves project (full loading executing only once).
			dispatch.execute(new GetProject(projectId, amendmentId, null), new CommandResultHandler<ProjectDTO>() {

				@Override
				protected void onCommandSuccess(final ProjectDTO project) {
					onProjectLoaded(project, event, page);
				}

				@Override
				protected void onCommandFailure(Throwable caught) {
					if(caught instanceof NotCachedException) {
						// BUGFIX #684: Displays an information message when the user tries to access an unavailable project.
						N10N.info(I18N.CONSTANTS.sigmahOfflineProjectNotCached());
						eventBus.updateZoneRequest(Zone.MENU_BANNER.requestWith(RequestParameter.CLOSE_CURRENT_TAB, Boolean.TRUE));
						
					} else {
						super.onCommandFailure(caught);
					}
				}
				
			});
		}
	}

	/**
	 * Method executed once project has been loaded.
	 * 
	 * @param loadedProject
	 *          The loaded project.
	 * @param event
	 *          The page request event.
	 * @param page
	 *          The accessed page.
	 */
	private void onProjectLoaded(final ProjectDTO loadedProject, final PageRequestEvent event, final Page page) {

		// Stores project instance into local attribute AND parent presenter.
		getParentPresenter().setCurrentProject(loadedProject);
		getParentPresenter().setCurrentDisplayedPhase(loadedProject.getCurrentPhase());

		final PageRequest request = event.getRequest();

		// Updates the tab title.
		eventBus.updateZoneRequest(Zone.MENU_BANNER.requestWith(RequestParameter.REQUEST, request).addData(RequestParameter.HEADER, loadedProject.getName()).addData(RequestParameter.PROJECT_ID, loadedProject.getId()));
				
		// Executes child page 'onPageRequest()'.
		afterOnPageRequest(event, page);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public ProjectPresenter getParentPresenter() {
		return injector.getProjectPresenter();
	}

	/**
	 * Returns the retrieved {@link ProjectDTO}.
	 * 
	 * @return The retrieved {@link ProjectDTO}.
	 */
	protected final ProjectDTO getProject() {
		return getParentPresenter().getCurrentProject();
	}

	/**
	 * Changes the way the project presenter loads projects.
	 * If <code>true</code>, a project already opened will not be loaded again
	 * until a different project has been selected.
	 * If <code>false</code>, projects will be reloaded every time.
	 * @param useCache <code>true</code> to use cache, <code>false</code> to reload the projects every time.
	 */
	protected void setUseCache(boolean useCache) {
		this.useCache = useCache;
	}

}