/*
* This file is part of LibrePlan
*
* Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
* Desenvolvemento Tecnolóxico de Galicia
* Copyright (C) 2010-2012 Igalia, S.L.
*
* 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.libreplan.business.planner.entities;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import javax.validation.Valid;
import javax.validation.constraints.AssertTrue;
import org.apache.commons.lang3.Validate;
import org.libreplan.business.common.entities.ProgressType;
import org.libreplan.business.orders.entities.TaskSource;
import org.libreplan.business.resources.daos.IResourcesSearcher;
import org.libreplan.business.scenarios.entities.Scenario;
import org.libreplan.business.util.TaskElementVisitor;
import org.libreplan.business.workingday.EffortDuration;
import org.libreplan.business.workingday.IntraDayDate;
/**
* @author Óscar González Fernández <ogonzalez@igalia.com>
* @author Javier Moran Rua <jmoran@igalia.com>
* @author Manuel Rego Casasnovas <rego@igalia.com>
*/
public class TaskGroup extends TaskElement {
public static TaskGroup create(TaskSource taskSource) {
TaskGroup taskGroup = new TaskGroup();
return create(taskGroup, taskSource);
}
private List<TaskElement> taskElements = new ArrayList<TaskElement>();
private PlanningData planningData;
/**
* Constructor for hibernate. Do not use!
*/
public TaskGroup() {
}
public BigDecimal getCriticalPathProgressByDuration() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getProgressByDuration();
}
public BigDecimal getCriticalPathProgressByNumHours() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getProgressByNumHours();
}
public BigDecimal getProgressAllByNumHours() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getProgressAllByNumHours();
}
public BigDecimal getTheoreticalProgressByNumHoursForAllTasksUntilNow() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getTheoreticalProgressByNumHoursForAllTasks();
}
public BigDecimal getTheoreticalProgressByDurationForCriticalPathUntilNow() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getTheoreticalProgressByDurationForCriticalPath();
}
public BigDecimal getTheoreticalProgressByNumHoursForCriticalPathUntilNow() {
if (planningData == null) {
return BigDecimal.ZERO;
}
return planningData.getTheoreticalProgressByNumHoursForCriticalPath();
}
@SuppressWarnings("unused")
@AssertTrue(message = "element associated to a task group have to be defined")
private boolean isTheOrderElementMustBeNotNullConstraint() {
return getOrderElement() != null;
}
public void addTaskElement(TaskElement task) {
Validate.notNull(task);
task.setParent(this);
addTaskElement(taskElements.size(), task);
IntraDayDate newPossibleEndDate = task.getIntraDayEndDate();
if (getIntraDayEndDate() == null
|| getIntraDayEndDate().compareTo(newPossibleEndDate) < 0) {
setIntraDayEndDate(newPossibleEndDate);
}
IntraDayDate newPossibleStart = task.getIntraDayStartDate();
if ( getIntraDayStartDate() == null
|| getIntraDayStartDate().compareTo(newPossibleStart) > 0 ) {
setIntraDayStartDate(newPossibleStart);
}
}
public void addTaskElement(Integer index, TaskElement task) {
Validate.notNull(task);
task.setParent(this);
taskElements.add(index, task);
}
@Override
@Valid
public List<TaskElement> getChildren() {
return Collections.unmodifiableList(taskElements);
}
@Override
public boolean isLeaf() {
return false;
}
public void remove(TaskElement taskElement) {
taskElements.remove(taskElement);
}
@Override
public Set<ResourceAllocation<?>> getSatisfiedResourceAllocations() {
Set<ResourceAllocation<?>> result = new HashSet<ResourceAllocation<?>>();
List<TaskElement> children = this.getChildren();
for (TaskElement child : children) {
result.addAll(child.getSatisfiedResourceAllocations());
}
return result;
}
@Override
public Set<ResourceAllocation<?>> getAllResourceAllocations() {
Set<ResourceAllocation<?>> result = new HashSet<ResourceAllocation<?>>();
for (TaskElement each : this.getChildren()) {
result.addAll(each.getAllResourceAllocations());
}
return result;
}
@Override
protected IDatesHandler createDatesHandler(Scenario scenario,
IResourcesSearcher resourcesSearcher) {
return new IDatesHandler() {
@Override
public void moveTo(IntraDayDate newStartDate) {
setIntraDayStartDate(newStartDate);
}
@Override
public void resizeTo(IntraDayDate endDate) {
setIntraDayEndDate(endDate);
}
@Override
public void moveEndTo(IntraDayDate newEnd) {
setIntraDayEndDate(newEnd);
}
};
}
public void setTaskChildrenTo(List<TaskElement> children) {
Validate.noNullElements(children);
int positionOnTaskElements = 0;
for (int i = 0; i < children.size(); i++) {
TaskElement element = children.get(i);
element.setParent(this);
if ( positionOnTaskElements >= taskElements.size() ) {
taskElements.add(element);
} else {
while (positionOnTaskElements < taskElements.size() &&
isMilestone(taskElements.get(positionOnTaskElements))) {
positionOnTaskElements++;
}
if ( positionOnTaskElements >= taskElements.size() ) {
taskElements.add(element);
} else {
taskElements.set(positionOnTaskElements, element);
}
}
positionOnTaskElements++;
}
ListIterator<TaskElement> listIterator = taskElements.listIterator(positionOnTaskElements);
while (listIterator.hasNext()) {
TaskElement current = listIterator.next();
if ( !isMilestone(current) ) {
listIterator.remove();
}
}
}
private boolean isMilestone(TaskElement t) {
// it can be null since removed elements are nullified in the list
return t != null && t.isMilestone();
}
@Override
protected void initializeDates() {
setIntraDayStartDate(getSmallestStartDateFromChildren());
setIntraDayEndDate(getBiggestEndDateFromChildren());
}
@Override
protected boolean canBeResized() {
return true;
}
@Override
public boolean canBeExplicitlyResized() {
return false;
}
@Override
public boolean isMilestone() {
return false;
}
@Override
public boolean hasLimitedResourceAllocation() {
return false;
}
public void fitStartAndEndDatesToChildren() {
setIntraDayStartDate(getSmallestStartDateFromChildren());
setIntraDayEndDate(getBiggestEndDateFromChildren());
}
public IntraDayDate getSmallestStartDateFromChildren() {
return Collections.min(getChildrenStartDates());
}
private List<IntraDayDate> getChildrenStartDates() {
List<IntraDayDate> result = new ArrayList<IntraDayDate>();
for (TaskElement each : getChildren()) {
result.add(each.getIntraDayStartDate());
}
return result;
}
public IntraDayDate getBiggestEndDateFromChildren() {
return Collections.max(getChildrenEndDates());
}
private List<IntraDayDate> getChildrenEndDates() {
List<IntraDayDate> result = new ArrayList<IntraDayDate>();
for (TaskElement each : getChildren()) {
result.add(each.getIntraDayEndDate());
}
return result;
}
public void updateCriticalPathProgress(List<TaskElement> criticalPath) {
Validate.isTrue(getParent() == null);
if (planningData == null) {
planningData = PlanningData.create(this);
}
List<Task> criticalPathJustTasks = new ArrayList<Task>();
for (TaskElement taskElement : criticalPath) {
if (taskElement instanceof Task) {
criticalPathJustTasks.add((Task) taskElement);
}
}
planningData.update(criticalPathJustTasks);
}
public void dontPoseAsTransientPlanningData() {
if (planningData != null) {
planningData.dontPoseAsTransientObjectAnymore();
}
}
/**
* For a root task, retrieves the progress selected by the progressType
* If there's not progressType, return taskElement.advancePercentage
*
*/
public BigDecimal getAdvancePercentage(ProgressType progressType) {
if (isTaskRoot(this) && (progressType != null)) {
switch (progressType) {
case ALL_NUMHOURS:
return getProgressAllByNumHours();
case CRITICAL_PATH_DURATION:
return getCriticalPathProgressByDuration();
case CRITICAL_PATH_NUMHOURS:
return getCriticalPathProgressByNumHours();
}
}
return super.getAdvancePercentage();
}
private boolean isTaskRoot(TaskGroup taskGroup) {
return taskGroup.getParent() == null;
}
@Override
public boolean isTask() {
return false;
}
@Override
public EffortDuration getTheoreticalCompletedTimeUntilDate(Date date) {
EffortDuration sum = EffortDuration.zero();
for (TaskElement each: taskElements) {
sum = EffortDuration.sum(sum, each.getTheoreticalCompletedTimeUntilDate(date));
}
return sum;
}
private Boolean isFinished = null;
private Boolean isInProgress = null;
@Override
public boolean isFinished() {
if ( this.isFinished == null ) {
this.isFinished = new Boolean(true);
for (TaskElement each: taskElements) {
if ( !each.isFinished() ) {
this.isFinished = new Boolean(false);
break;
}
}
}
return this.isFinished.booleanValue();
}
@Override
public boolean isInProgress() {
if (this.isInProgress == null) {
this.isInProgress = new Boolean(false);
for (TaskElement each: taskElements) {
if (each.isInProgress()) {
this.isInProgress = new Boolean(true);
break;
}
}
}
return this.isInProgress.booleanValue();
}
@Override
public void acceptVisitor(TaskElementVisitor visitor) {
visitor.visit(this);
}
@Override
public void resetStatus() {
this.isFinished = this.isInProgress = null;
}
@Override
public boolean isAnyTaskWithConstraint(PositionConstraintType type) {
for (TaskElement taskElement : getChildren()) {
if (taskElement.isAnyTaskWithConstraint(type)) {
return true;
}
}
return false;
}
@Override
public void setTaskSource(TaskSource taskSource) {
super.setTaskSource(taskSource);
}
}