xdev.ui.ganttchart.action.ValidationGanttRelationController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of csapi Show documentation
XDEV Component Suite
There is a newer version: 6.0.2
package xdev.ui.ganttchart.action;

/*-
 * #%L
 * XDEV BI Suite
 * %%
 * Copyright (C) 2011 - 2021 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it 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.
 * 
 * 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import xdev.ui.ganttchart.UpdateableGanttEntry;
import xdev.ui.ganttchart.template.RelationalGanttTemplate;

import com.jidesoft.gantt.GanttEntry;
import com.jidesoft.gantt.GanttEntryRelation;
import com.jidesoft.gantt.GanttEntryRelationModel;


/**
 * Manages the dis/-connection betweeen {@link GanttEntry}s.
 * 
 * This concrete implementation validates the {@link GanttEntryRelation}.
 * 
 * 
 * 
 * 
 * @param 
 *            the gantt data type, for example Date or
 *            Integer. Has to extend {@link Comparable} for
 *            validation purpose.
 *            
 *            Used for entry scaling via {@link GanttEntry#getRange()}
 *            
 * @param 
 *            the customized {@link GanttEntry} type.
 * 
 * @author XDEV Software jwill
 * @since 4.0
 * 
 */
public class ValidationGanttRelationController, S extends UpdateableGanttEntry>
		implements GanttRelationController
{
	
	/**
	 * the specific implementation of {@link GanttRelationValidationStrategy}
	 * which informs if the validation failed.
	 */
	private GanttRelationValidationStrategy	strategy;
	
	private final RelationalGanttTemplate		template;
	
	
	/**
	 * 
	 * @param model
	 *            the {@link GanttEntryRelationModel} to register the upcoming
	 *            relations.
	 */
	public ValidationGanttRelationController(RelationalGanttTemplate template)
	{
		this.template = template;
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setRelationValidationStrategy(GanttRelationValidationStrategy strategy)
	{
		this.strategy = strategy;
	}
	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public GanttRelationValidationStrategy getRelationValidationStrategy()
	{
		if(this.strategy == null)
		{
			return new DefaultRelationValidationStrategy();
		}
		else
		{
			return this.strategy;
		}
	}
	
	
	@Override
	public void removeEntryRelation(GanttEntryRelation relation)
	{
		//no persistence is valid
		if(this.template.getGanttRelationPersistence() != null)
		{
			this.template.getGanttRelationPersistence().removeRelation(relation);
		}
	}
	
	
	@Override
	public void insertEntryRelation(GanttEntryRelation relation)
	{
		if(this.getRelationValidationStrategy() != null)
		{
			if(this.getRelationValidationStrategy().validateRelation(relation))
			{
				if(this.template.getGanttRelationPersistence() != null) // no
				// persistence
				// is
				// valid
				{
					this.template.getGanttRelationPersistence().addRelation(relation);
				}
			}
		}
	}
}