GenomeWindowEvent.java

/*******************************************************************************
 * GenPlay, Einstein Genome Analyzer
 * Copyright (C) 2009, 2014 Albert Einstein College of Medicine
 * 
 * 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/>.
 * Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
 *          Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
 *          Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
 * 
 * Website: <http://genplay.einstein.yu.edu>
 ******************************************************************************/
package edu.yu.einstein.genplay.gui.event.genomeWindowEvent;

import java.util.EventObject;

import edu.yu.einstein.genplay.dataStructure.chromosome.Chromosome;
import edu.yu.einstein.genplay.dataStructure.chromosomeWindow.ChromosomeWindow;
import edu.yu.einstein.genplay.dataStructure.genomeWindow.GenomeWindow;


/**
 * The {@link GenomeWindow} event emitted by a {@link GenomeWindowEventsGenerator} object.
 * @author Julien Lajugie
 * @version 0.1
 */
public final class GenomeWindowEvent extends EventObject {

	private static final long serialVersionUID = -5909384700520572038L;	// generated ID
	private final GenomeWindowEventsGenerator 	source;		// GenomeWindowEventsGenerator that emitted the event
	private final GenomeWindow 					oldWindow;	// old GenomeWindow
	private final GenomeWindow 					newWindow;	// new GenomeWindow


	/**
	 * Creates an instance of {@link GenomeWindowEvent}
	 * @param source {@link GenomeWindowEventsGenerator} that emitted this event
	 * @param oldWindow value of the {@link GenomeWindow} before changes
	 * @param newWindow value of the {@link GenomeWindow} after changes
	 */
	public GenomeWindowEvent(GenomeWindowEventsGenerator source, GenomeWindow oldWindow, GenomeWindow newWindow) {
		super(source);
		this.source = source;
		this.oldWindow = oldWindow;
		this.newWindow = newWindow;
	}


	/**
	 * @return true if the {@link Chromosome} of the {@link GenomeWindow} changed
	 */
	public boolean chromosomeChanged() {
		if ((oldWindow == null) && (newWindow != null)) {
			return true;
		}
		return !oldWindow.getChromosome().equals(newWindow.getChromosome());
	}


	/**
	 * @return true if the {@link ChromosomeWindow} of the {@link GenomeWindow} changed
	 */
	public boolean chromosomeWindowChanged() {
		return !oldWindow.equals(newWindow);
	}


	/**
	 * @return the newWindow
	 */
	public final GenomeWindow getNewWindow() {
		return newWindow;
	}


	/**
	 * @return the oldWindow
	 */
	public final GenomeWindow getOldWindow() {
		return oldWindow;
	}


	/**
	 * @return the source
	 */
	@Override
	public final GenomeWindowEventsGenerator getSource() {
		return source;
	}


	/**
	 * @return true if the size of the {@link GenomeWindow} changed
	 */
	public boolean zoomChanged() {
		return oldWindow.getSize() != newWindow.getSize();
	}
}