FilteredObservationMessage.java

/**
 * VStar: a statistical analysis tool for variable star data.
 * Copyright (C) 2010  AAVSO (http://www.aavso.org/)
 *
 * 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 Affero 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/>. 
 */
package org.aavso.tools.vstar.ui.mediator.message;

import java.util.LinkedHashSet;
import java.util.Set;

import org.aavso.tools.vstar.data.ValidObservation;
import org.aavso.tools.vstar.data.filter.IFilterDescription;

/**
 * Instances of this message should be sent when an observation filtering
 * operation has occurred.
 */
public class FilteredObservationMessage extends MessageBase {

	public static final FilteredObservationMessage NO_FILTER = null;

	private IFilterDescription filterDesc;
	private Set<ValidObservation> filteredObs;

	/**
	 * Constructor.
	 * 
	 * @param source
	 *            The source of the message.
	 * @param filterDesc
	 *            A description of the filter.
	 * @param filteredObsMap
	 *            A sorted subset of valid observations.
	 */
	public FilteredObservationMessage(Object source, IFilterDescription filterDesc,
			Set<ValidObservation> filteredObs) {
		super(source);
		this.filterDesc = filterDesc;
		
		Set<ValidObservation> newSeriesObs = new LinkedHashSet<ValidObservation>();
		for (ValidObservation ob : filteredObs) {
			newSeriesObs.add(ob.copy());
		}
		
		this.filteredObs = newSeriesObs;
	}

	/**
	 * @return the filterDesc
	 */
	public IFilterDescription getDescription() {
		return filterDesc;
	}

	/**
	 * @return the filteredObs
	 */
	public Set<ValidObservation> getFilteredObs() {
		return filteredObs;
	}
}