SynchroImportContextVO

package fr.ifremer.quadrige2.synchro.vo;

/*-
 * #%L
 * Quadrige2 Core :: Quadrige2 Synchro Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2017 Ifremer
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import com.google.common.collect.Multimap;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.Serializable;
import java.util.Date;
import java.util.Set;

/**
 * <p>
 * SynchroImportContextVO class.
 * </p>
 *
 * @author Ludovic Pecquot <ludovic.pecquot@e-is.pro>
 * @since 1.0
 */
public class SynchroImportContextVO implements Serializable, Cloneable {

	private static final long serialVersionUID = 2375804877480968569L;

	/** Constant <code>PROPERTY_JOB_ID="jobId"</code> */
	public static final String PROPERTY_JOB_ID = "jobId";
	/** Constant <code>PROPERTY_REFERENTIAL_UPDATE_DATE="referentialUpdateDate"</code> */
	public static final String PROPERTY_REFERENTIAL_UPDATE_DATE = "referentialUpdateDate";
	/** Constant <code>PROPERTY_DATA_UPDATE_DATE="dataUpdateDate"</code> */
	public static final String PROPERTY_DATA_UPDATE_DATE = "dataUpdateDate";
	/** Constant <code>PROPERTY_DATA_START_DATE="dataStartDate"</code> */
	public static final String PROPERTY_DATA_START_DATE = "dataStartDate";
	/** Constant <code>PROPERTY_DATA_END_DATE="dataEndDate"</code> */
	public static final String PROPERTY_DATA_END_DATE = "dataEndDate";
	/** Constant <code>PROPERTY_WITH_REFERENTIAL="withReferential"</code> */
	public static final String PROPERTY_WITH_REFERENTIAL = "withReferential";
	/** Constant <code>PROPERTY_WITH_DATA="withData"</code> */
	public static final String PROPERTY_WITH_DATA = "withData";
	/** Constant <code>PROPERTY_REFERENTIAL_PK_INCLUDES="referentialPkIncludes"</code> */
	public static final String PROPERTY_REFERENTIAL_PK_INCLUDES = "referentialPkIncludes";
	/** Constant <code>PROPERTY_DATA_PK_INCLUDES="dataPkIncludes"</code> */
	public static final String PROPERTY_DATA_PK_INCLUDES = "dataPkIncludes";
	/** Constant <code>PROPERTY_FORCE_DUPLICATION="forceDuplication"</code> */
	public static final String PROPERTY_FORCE_DUPLICATION = "forceDuplication";
	/** Constant <code>PROPERTY_DATA_PROGRAM_CODES="dataProgramCodes"</code> */
	public static final String PROPERTY_DATA_PROGRAM_CODES = "dataProgramCodes";
	/** Constant <code>PROPERTY_REFERENTIAL_PROGRAM_CODES="referentialProgramCodes"</code> */
	public static final String PROPERTY_REFERENTIAL_PROGRAM_CODES = "referentialProgramCodes";
	/** Constant <code>PROPERTY_DATA_FORCE_EDITED_ROW_OVERRIDE="dataForceEditedRowOverride"</code> */
	public static final String PROPERTY_DATA_FORCE_EDITED_ROW_OVERRIDE = "dataForceEditedRowOverride";

	private String jobId;
	private Date referentialUpdateDate;
	private Date dataUpdateDate;
	private Date dataStartDate;
	private Date dataEndDate;
	private Multimap<String, String> referentialPkIncludes;
	private Multimap<String, String> dataPkIncludes;
	private boolean forceDuplication = false;
	private Set<String> dataProgramCodes;
	private Set<String> referentialProgramCodes;
	private boolean dataForceEditedRowOverride = false;
	private boolean withReferential = false;
	private boolean withData = false;
	private boolean referentialProgramsForceImport = false;

	transient PropertyChangeSupport pcs = new PropertyChangeSupport(this);

	/**
	 * <p>
	 * Constructor for SynchroImportContextVO.
	 * </p>
	 */
	public SynchroImportContextVO() {
	}

	/**
	 * <p>
	 * Constructor for SynchroImportContextVO.
	 * </p>
	 *
	 * @param otherBean
	 *            a {@link fr.ifremer.quadrige2.synchro.vo.SynchroImportContextVO} object.
	 */
	protected SynchroImportContextVO(SynchroImportContextVO otherBean) {
		this();
		copy(otherBean);
	}

	/**
	 * <p>
	 * addPropertyChangeListener.
	 * </p>
	 *
	 * @param listener
	 *            a {@link java.beans.PropertyChangeListener} object.
	 */
	public void addPropertyChangeListener(PropertyChangeListener listener) {
		this.pcs.addPropertyChangeListener(listener);
	}

	/**
	 * <p>
	 * removePropertyChangeListener.
	 * </p>
	 *
	 * @param listener
	 *            a {@link java.beans.PropertyChangeListener} object.
	 */
	public void removePropertyChangeListener(PropertyChangeListener listener) {
		this.pcs.removePropertyChangeListener(listener);
	}

	/** {@inheritDoc} */
	@Override
	public Object clone() {
		return new SynchroImportContextVO().copy(this);
	}

	/**
	 * <p>
	 * Getter for the field <code>jobId</code>.
	 * </p>
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getJobId() {
		return jobId;
	}

	/**
	 * <p>
	 * Setter for the field <code>jobId</code>.
	 * </p>
	 *
	 * @param jobId
	 *            a {@link java.lang.String} object.
	 */
	public void setJobId(String jobId) {
		this.jobId = jobId;
		this.pcs.firePropertyChange(PROPERTY_JOB_ID, null, jobId);
	}

	/**
	 * <p>
	 * Getter for the field <code>referentialUpdateDate</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Date} object.
	 */
	public Date getReferentialUpdateDate() {
		return referentialUpdateDate;
	}

	/**
	 * <p>
	 * Setter for the field <code>referentialUpdateDate</code>.
	 * </p>
	 *
	 * @param referentialUpdateDate
	 *            a {@link java.util.Date} object.
	 */
	public void setReferentialUpdateDate(Date referentialUpdateDate) {
		this.referentialUpdateDate = referentialUpdateDate;
	}

	/**
	 * <p>
	 * Getter for the field <code>dataUpdateDate</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Date} object.
	 */
	public Date getDataUpdateDate() {
		return dataUpdateDate;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataUpdateDate</code>.
	 * </p>
	 *
	 * @param dataUpdateDate
	 *            a {@link java.util.Date} object.
	 */
	public void setDataUpdateDate(Date dataUpdateDate) {
		this.dataUpdateDate = dataUpdateDate;
	}

	/**
	 * <p>
	 * Getter for the field <code>dataStartDate</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Date} object.
	 */
	public Date getDataStartDate() {
		return dataStartDate;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataStartDate</code>.
	 * </p>
	 *
	 * @param dataStartDate
	 *            a {@link java.util.Date} object.
	 */
	public void setDataStartDate(Date dataStartDate) {
		this.dataStartDate = dataStartDate;
	}

	/**
	 * <p>
	 * Getter for the field <code>dataEndDate</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Date} object.
	 */
	public Date getDataEndDate() {
		return dataEndDate;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataEndDate</code>.
	 * </p>
	 *
	 * @param dataEndDate
	 *            a {@link java.util.Date} object.
	 */
	public void setDataEndDate(Date dataEndDate) {
		this.dataEndDate = dataEndDate;
	}

	/**
	 * <p>
	 * Getter for the field <code>referentialPkIncludes</code>.
	 * </p>
	 *
	 * @return a {@link com.google.common.collect.Multimap} object.
	 */
	public Multimap<String, String> getReferentialPkIncludes() {
		return referentialPkIncludes;
	}

	/**
	 * <p>
	 * Setter for the field <code>referentialPkIncludes</code>.
	 * </p>
	 *
	 * @param referentialPkIncludes
	 *            a {@link com.google.common.collect.Multimap} object.
	 */
	public void setReferentialPkIncludes(Multimap<String, String> referentialPkIncludes) {
		this.referentialPkIncludes = referentialPkIncludes;
	}

	/**
	 * <p>
	 * Getter for the field <code>dataPkIncludes</code>.
	 * </p>
	 *
	 * @return a {@link com.google.common.collect.Multimap} object.
	 */
	public Multimap<String, String> getDataPkIncludes() {
		return dataPkIncludes;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataPkIncludes</code>.
	 * </p>
	 *
	 * @param dataPkIncludes
	 *            a {@link com.google.common.collect.Multimap} object.
	 */
	public void setDataPkIncludes(Multimap<String, String> dataPkIncludes) {
		this.dataPkIncludes = dataPkIncludes;
	}

	/**
	 * <p>
	 * isForceDuplication.
	 * </p>
	 *
	 * @return a boolean.
	 */
	public boolean isForceDuplication() {
		return forceDuplication;
	}

	/**
	 * <p>
	 * Setter for the field <code>forceDuplication</code>.
	 * </p>
	 *
	 * @param forceDuplication
	 *            a boolean.
	 */
	public void setForceDuplication(boolean forceDuplication) {
		this.forceDuplication = forceDuplication;
	}

	/**
	 * <p>
	 * isWithReferential.
	 * </p>
	 *
	 * @return a boolean.
	 */
	public boolean isWithReferential() {
		return withReferential;
	}

	/**
	 * <p>
	 * Setter for the field <code>withReferential</code>.
	 * </p>
	 *
	 * @param referential
	 *            a boolean.
	 */
	public void setWithReferential(boolean referential) {
		this.withReferential = referential;
	}

	/**
	 * <p>
	 * isWithData.
	 * </p>
	 *
	 * @return a boolean.
	 */
	public boolean isWithData() {
		return withData;
	}

	/**
	 * <p>
	 * Setter for the field <code>withData</code>.
	 * </p>
	 *
	 * @param data
	 *            a boolean.
	 */
	public void setWithData(boolean data) {
		this.withData = data;
	}

	/**
	 * <p>
	 * isDataForceEditedRowOverride.
	 * </p>
	 *
	 * @return a boolean.
	 */
	public boolean isDataForceEditedRowOverride() {
		return dataForceEditedRowOverride;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataForceEditedRowOverride</code>.
	 * </p>
	 *
	 * @param dataForceEditedRowOverride
	 *            a boolean.
	 */
	public void setDataForceEditedRowOverride(boolean dataForceEditedRowOverride) {
		this.dataForceEditedRowOverride = dataForceEditedRowOverride;
	}

	/**
	 * <p>
	 * Getter for the field <code>dataProgramCodes</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Set} object.
	 */
	public Set<String> getDataProgramCodes() {
		return dataProgramCodes;
	}

	/**
	 * <p>
	 * Setter for the field <code>dataProgramCodes</code>.
	 * </p>
	 *
	 * @param dataProgramCodes
	 *            a {@link java.util.Set} object.
	 */
	public void setDataProgramCodes(Set<String> dataProgramCodes) {
		this.dataProgramCodes = dataProgramCodes;
	}

	/**
	 * <p>
	 * Getter for the field <code>referentialProgramCodes</code>.
	 * </p>
	 *
	 * @return a {@link java.util.Set} object.
	 */
	public Set<String> getReferentialProgramCodes() {
		return referentialProgramCodes;
	}

	/**
	 * <p>
	 * Setter for the field <code>referentialProgramCodes</code>.
	 * </p>
	 *
	 * @param referentialProgramCodes
	 *            a {@link java.util.Set} object.
	 */
	public void setReferentialProgramCodes(Set<String> referentialProgramCodes) {
		this.referentialProgramCodes = referentialProgramCodes;
	}

	/**
	 * <p>
	 * Setter for the field <code>referentialProgramsForceImport</code>.
	 * </p>
	 *
	 * @param referentialProgramsForceImport
	 *            a boolean.
	 */
	public void setReferentialProgramsForceImport(boolean referentialProgramsForceImport) {
		this.referentialProgramsForceImport = referentialProgramsForceImport;
	}

	/**
	 * <p>
	 * Getter for the field <code>referentialProgramsForceImport</code>.
	 * </p>
	 *
	 * @return a boolean.
	 */
	public boolean getReferentialProgramsForceImport() {
		return this.referentialProgramsForceImport;
	}

	/* -- protected methods -- */

	/**
	 * <p>
	 * copy.
	 * </p>
	 *
	 * @param other
	 *            a {@link fr.ifremer.quadrige2.synchro.vo.SynchroImportContextVO} object.
	 * @return a {@link fr.ifremer.quadrige2.synchro.vo.SynchroImportContextVO} object.
	 */
	protected SynchroImportContextVO copy(SynchroImportContextVO other) {
		this.jobId = other.jobId;
		this.referentialUpdateDate = other.referentialUpdateDate;
		this.dataUpdateDate = other.dataUpdateDate;
		this.dataStartDate = other.dataStartDate;
		this.dataEndDate = other.dataEndDate;
		this.dataPkIncludes = other.dataPkIncludes;
		this.dataProgramCodes = other.dataProgramCodes;
		this.dataForceEditedRowOverride = other.dataForceEditedRowOverride;
		this.withReferential = other.withReferential;
		this.withData = other.withData;
		this.referentialProgramCodes = other.referentialProgramCodes;
		this.referentialProgramsForceImport = other.referentialProgramsForceImport;
		return this;
	}
}