xdev.ui.ganttchart.utils.XdevGanttPersistenceCalculationUtils 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.utils;

/*-
 * #%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 com.jidesoft.gantt.GanttEntry;


/**
 * Utility class to calculate values for comprehensive {@link GanttEntry}s.
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public class XdevGanttPersistenceCalculationUtils
{
	
	/**
	 * 
	 * @param parentEntry
	 *            the parent entry to calculate the subentries completion from.
	 * 
	 * @param 
	 *            the gantt data type, for example Date or
	 *            Integer.
	 *            
	 *            Used for entry scaling via {@link GanttEntry#getRange()}
	 *            
	 *            .
	 * @param 
	 *            the customized {@link GanttEntry} type.
	 * 
	 * @return the average completion of all subentries,
	 */
	// have to type class based because jide base interface does not provide
	// #getSubEntries.
	public static > Double getParentCompletionValue(S parentEntry)
	{
		Double completion = 0.0;
		
		for(Object childEntry : parentEntry.getChildren())
		{
			// cant avoid cast because of JIDE API. (getParent returnVal !=
			// Generic
			// Type)
			GanttEntry calcEntry = (GanttEntry)childEntry;
			completion += calcEntry.getCompletion();
		}
		
		return completion / parentEntry.getChildren().size();
	}
	
}