ValueEvent.java

package org.sigmah.shared.dto.element.event;

/*
 * #%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 com.google.gwt.event.shared.GwtEvent;

import java.io.Serializable;
import java.util.Set;

import org.sigmah.client.util.ToStringBuilder;
import org.sigmah.shared.dto.element.FlexibleElementDTO;
import org.sigmah.shared.dto.referential.ValueEventChangeType;
import org.sigmah.shared.dto.value.TripletValueDTO;

/**
 * Event transmitted to the {@link org.sigmah.client.ui.presenter.orgunit.OrgUnitPresenter OrgUnitPresenter} when a
 * flexible element value changes.
 *
 * @author HUZHE
 * @author Denis Colliot (dcolliot@ideia.fr)
 */
public class ValueEvent extends GWTImmortalEvent<ValueHandler> implements Serializable {

	/**
	 * Serial version UID.
	 */
	private static final long serialVersionUID = -6920472009097129066L;

	private final static GwtEvent.Type<ValueHandler> TYPE = new GwtEvent.Type<ValueHandler>();

	private FlexibleElementDTO sourceElement;
	private TripletValueDTO tripletValue;
	private String singleValue;
	private Set<Integer> multivaluedIdsValue;

	// Only used for the elements part of a list.
	private ValueEventChangeType changeType;
	boolean isProjectCountryChanged = false;
	//Only used if the element is part of an iteration
	private Integer iterationId;

	public ValueEvent(FlexibleElementDTO sourceElement, String singleValue) {
		this.sourceElement = sourceElement;
		this.singleValue = singleValue;
	}

	public ValueEvent(FlexibleElementDTO sourceElement, Set<Integer> multivaluedIdsValue, ValueEventChangeType changeType) {
		this.sourceElement = sourceElement;
		this.multivaluedIdsValue = multivaluedIdsValue;
		this.changeType = changeType;
	}

	public ValueEvent(FlexibleElementDTO sourceElement, Set<Integer> multivaluedIdsValue, ValueEventChangeType changeType, Integer iterationId) {
		this.sourceElement = sourceElement;
		this.multivaluedIdsValue = multivaluedIdsValue;
		this.changeType = changeType;
		this.iterationId = iterationId;
	}

	/**
	 * ValueEvent that is unique for OrgUnit DefaultFlexibleElement
	 * 
	 * @param orgUnitElement
	 *          OrgUnit DefaultFlxibleElement
	 * @param singleValue
	 *          Name of OrgUnit
	 * @param isProjectCountryChanged
	 *          If the OrgUnit element is attached to a project,specify if you want to change the OrgUnit of the project
	 *          by the new orgunit's country,or just change the OrgUnit without touching the country of project.
	 */
	public ValueEvent(FlexibleElementDTO orgUnitElement, String singleValue, boolean isProjectCountryChanged) {
		this.sourceElement = orgUnitElement;
		this.singleValue = singleValue;
		this.isProjectCountryChanged = isProjectCountryChanged;
	}

	public ValueEvent(FlexibleElementDTO sourceElement, TripletValueDTO tripletValue) {
		this.sourceElement = sourceElement;
		this.tripletValue = tripletValue;
		this.changeType = ValueEventChangeType.ADD;
	}

	public ValueEvent(FlexibleElementDTO sourceElement, TripletValueDTO tripletValue, ValueEventChangeType changeType) {
		this.sourceElement = sourceElement;
		this.tripletValue = tripletValue;
		if (changeType == null) {
			this.changeType = ValueEventChangeType.ADD;
		} else {
			this.changeType = changeType;
		}
	}

	public ValueEvent(FlexibleElementDTO sourceElement, TripletValueDTO tripletValue, ValueEventChangeType changeType, Integer iterationId) {
		this.sourceElement = sourceElement;
		this.tripletValue = tripletValue;
		if (changeType == null) {
			this.changeType = ValueEventChangeType.ADD;
		} else {
			this.changeType = changeType;
		}
		this.iterationId = iterationId;
	}

	@Override
	protected void dispatch(ValueHandler handler) {
		handler.onValueChange(this);
	}

	@Override
	public GwtEvent.Type<ValueHandler> getAssociatedType() {
		return TYPE;
	}

	public static Type<ValueHandler> getType() {
		return TYPE;
	}

	public void setSourceElement(FlexibleElementDTO sourceElement) {
		this.sourceElement = sourceElement;
	}

	public FlexibleElementDTO getSourceElement() {
		return sourceElement;
	}

	public ValueEventChangeType getChangeType() {
		return changeType;
	}

	public void setChangeType(ValueEventChangeType changeType) {
		this.changeType = changeType;
	}

	public TripletValueDTO getTripletValue() {
		return tripletValue;
	}

	public void setTripletValue(TripletValueDTO tripletValue) {
		this.tripletValue = tripletValue;
	}

	public String getSingleValue() {
		return singleValue;
	}

	public void setSingleValue(String singleValue) {
		this.singleValue = singleValue;
	}

	public Set<Integer> getMultivaluedIdsValue() {
		return multivaluedIdsValue;
	}

	public void setMultivaluedIdsValue(Set<Integer> multivaluedIdsValue) {
		this.multivaluedIdsValue = multivaluedIdsValue;
	}

	/**
	 * @return the isProjectCountryChanged
	 */
	public boolean isProjectCountryChanged() {
		return isProjectCountryChanged;
	}

	/**
	 * @param isProjectCountryChanged
	 *          the isProjectCountryChanged to set
	 */
	public void setProjectCountryChanged(boolean isProjectCountryChanged) {
		this.isProjectCountryChanged = isProjectCountryChanged;
	}

	public Integer getIterationId() {
		return iterationId;
	}

	public void setIterationId(Integer iterationId) {
		this.iterationId = iterationId;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		final ToStringBuilder builder = new ToStringBuilder(this);

		builder.append("source", sourceElement.getId());
		builder.append("value", singleValue);
		builder.append("tripletValue", tripletValue);
		builder.append("changeType", changeType);
		builder.append("iterationId", iterationId);

		return builder.toString();
	}

}