AlignmentTask.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.ui.views.tasks.model.impl;

import java.util.List;

import eu.esdihumboldt.hale.schemaprovider.model.Definition;
import eu.esdihumboldt.hale.ui.service.HaleServiceListener;
import eu.esdihumboldt.hale.ui.service.UpdateMessage;
import eu.esdihumboldt.hale.ui.service.mapping.AlignmentService;
import eu.esdihumboldt.hale.ui.service.mapping.AlignmentServiceListener;
import eu.esdihumboldt.hale.ui.views.tasks.model.ServiceProvider;
import eu.esdihumboldt.specification.cst.align.ICell;

/**
 * A task that listens to the alignment service
 *
 * @author Simon Templer
 * @partner 01 / Fraunhofer Institute for Computer Graphics Research
 */
public abstract class AlignmentTask extends SchemaTask implements AlignmentServiceListener {
	
	/**
	 * The alignment service
	 */
	protected final AlignmentService alignmentService;
	
	/**
	 * Creates an alignment task
	 * 
	 * @param serviceProvider the service provider
	 * @param typeName the type name
	 * @param context the task context
	 */
	public AlignmentTask(ServiceProvider serviceProvider, String typeName, 
			List<? extends Definition> context) {
		super(serviceProvider, typeName, context);
		
		this.alignmentService = serviceProvider.getService(AlignmentService.class);
		
		alignmentService.addListener(this);
	}

	/**
	 * @see HaleServiceListener#update(UpdateMessage)
	 */
	@Override
	public void update(@SuppressWarnings("rawtypes") UpdateMessage message) {
		// override me - but only if it's really necessary, rather use other event notifications
	}

	/**
	 * @see AlignmentServiceListener#alignmentCleared()
	 */
	@Override
	public void alignmentCleared() {
		// override me
	}

	/**
	 * @see AlignmentServiceListener#cellRemoved(ICell)
	 */
	@Override
	public void cellRemoved(ICell cell) {
		// override me
	}

	/**
	 * @see AlignmentServiceListener#cellsAdded(Iterable)
	 */
	@Override
	public void cellsAdded(Iterable<ICell> cells) {
		// override me
	}

	/**
	 * @see AlignmentServiceListener#cellsUpdated(Iterable)
	 */
	@Override
	public void cellsUpdated(Iterable<ICell> cells) {
		// override me
	}

	/**
	 * @see DefaultTask#dispose()
	 */
	@Override
	public void dispose() {
		alignmentService.removeListener(this);
		
		super.dispose();
	}

}