net.sourceforge.plantuml.project.GanttDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML 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.
*
* PlantUML 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 Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see draws = new LinkedHashMap();
private final Map tasks = new LinkedHashMap();
private final List constraints = new ArrayList<>();
private final HColorSet colorSet = HColorSet.instance();
private final OpenClose openClose = new OpenClose();
private final Map resources = new LinkedHashMap();
private final Map colorDaysToday = new HashMap();
private final Map colorDaysInternal = new HashMap();
private final Map colorDaysOfWeek = new HashMap();
private final Map nameDays = new HashMap();
private LabelStrategy labelStrategy = new LabelStrategy(LabelPosition.LEGACY, HorizontalAlignment.LEFT);
// Let's follow ISO-8601 rules
private WeekNumberStrategy weekNumberStrategy = new WeekNumberStrategy(DayOfWeek.MONDAY, 4);
private PrintScale printScale = PrintScale.DAILY;
private double factorScale = 1.0;
private Locale locale = Locale.ENGLISH;
private Day today;
private double totalHeightWithoutFooter;
private Day min = Day.create(0);
private Day max;
private Day printStart;
private Day printEnd;
private final RealOrigin origin = RealUtils.createOrigin();
private int defaultCompletion = 100;
private Task it;
private Resource they;
public CommandExecutionResult changeLanguage(String lang) {
this.locale = new Locale(lang);
return CommandExecutionResult.ok();
}
public DiagramDescription getDescription() {
return new DiagramDescription("(Gantt)");
}
public void setWeekNumberStrategy(DayOfWeek firstDayOfWeek, int minimalDaysInFirstWeek) {
this.weekNumberStrategy = new WeekNumberStrategy(firstDayOfWeek, minimalDaysInFirstWeek);
}
public GanttDiagram(UmlSource source) {
super(source, UmlDiagramType.GANTT, null);
}
public final int getDpi(FileFormatOption fileFormatOption) {
return 96;
}
@Override
protected ImageData exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
return createImageBuilder(fileFormatOption).drawable(getTextMainBlock(fileFormatOption)).write(os);
}
public void setPrintScale(PrintScale printScale) {
this.printScale = printScale;
}
public void setFactorScale(double factorScale) {
this.factorScale = factorScale;
}
private double getFactorScale() {
return this.printScale.getDefaultScale() * this.factorScale;
}
private boolean isHidden(Task task) {
if (printStart == null || task instanceof TaskSeparator)
return false;
if (task.getEnd().compareTo(min) < 0)
return true;
if (task.getStart().compareTo(max) > 0)
return true;
return false;
}
@Override
public String checkFinalError() {
try {
initMinMax();
} catch (ImpossibleSolvingException ex) {
return ex.getMessage();
}
return null;
}
@Override
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption) {
final StringBounder stringBounder = fileFormatOption.getDefaultStringBounder(getSkinParam());
if (printStart == null) {
initMinMax();
} else {
this.min = printStart;
this.max = printEnd;
}
final TimeHeader timeHeader = getTimeHeader(stringBounder);
initTaskAndResourceDraws(timeHeader.getTimeScale(), timeHeader.getFullHeaderHeight(stringBounder),
stringBounder);
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
try {
final UGraphic ugOrig = ug;
if (labelStrategy.titleInFirstColumn())
ug = ug.apply(UTranslate.dx(getTitlesColumnWidth(ug.getStringBounder())));
final Style timelineStyle = StyleSignatureBasic
.of(SName.root, SName.element, SName.ganttDiagram, SName.timeline)
.getMergedStyle(getCurrentStyleBuilder());
final HColor back = timelineStyle.value(PName.BackGroundColor).asColor(getIHtmlColorSet());
if (back.isTransparent() == false) {
final URectangle rect1 = URectangle.build(calculateDimension(ug.getStringBounder()).getWidth(),
timeHeader.getTimeHeaderHeight(ug.getStringBounder()));
ug.apply(back.bg()).draw(rect1);
if (showFootbox) {
final URectangle rect2 = URectangle.build(
calculateDimension(ug.getStringBounder()).getWidth(),
timeHeader.getTimeFooterHeight(ug.getStringBounder()));
ug.apply(back.bg()).apply(UTranslate.dy(totalHeightWithoutFooter)).draw(rect2);
}
}
timeHeader.drawTimeHeader(ug, totalHeightWithoutFooter);
drawConstraints(ug, timeHeader.getTimeScale());
drawTasksRect(ug);
drawTasksTitle(ugOrig, getTitlesColumnWidth(ug.getStringBounder()), getBarsColumnWidth(timeHeader));
if (hideResourceFoobox == false)
drawResources(ug);
if (showFootbox)
timeHeader.drawTimeFooter(ug.apply(UTranslate.dy(totalHeightWithoutFooter)));
} catch (Throwable t) {
Logme.error(t);
final UDrawable crash = new GraphvizCrash(getSource().getPlainString(BackSlash.lineSeparator()),
false, t);
crash.drawU(ug);
}
}
private double getTitlesColumnWidth(StringBounder stringBounder) {
if (labelStrategy.titleInside())
return 0;
double width = 0;
for (Task task : tasks.values()) {
if (isHidden(task))
continue;
width = Math.max(width, draws.get(task).getTitleWidth(stringBounder));
}
return width;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(getTitlesColumnWidth(stringBounder) + getBarsColumnWidth(timeHeader),
getTotalHeight(stringBounder, timeHeader));
}
private double getBarsColumnWidth(final TimeHeader timeHeader) {
final double xmin = timeHeader.getTimeScale().getStartingPosition(min);
final double xmax = timeHeader.getTimeScale().getEndingPosition(max);
return xmax - xmin;
}
};
}
private TimeHeader getTimeHeader(StringBounder stringBounder) {
if (openClose.getStartingDay() == null)
return new TimeHeaderSimple(stringBounder, thParam(), printScale);
else if (printScale == PrintScale.DAILY)
return new TimeHeaderDaily(stringBounder, thParam(), nameDays, printStart);
else if (printScale == PrintScale.WEEKLY)
return new TimeHeaderWeekly(stringBounder, thParam(), weekNumberStrategy, weeklyHeaderStrategy, printStart);
else if (printScale == PrintScale.MONTHLY)
return new TimeHeaderMonthly(stringBounder, thParam(), printStart);
else if (printScale == PrintScale.QUARTERLY)
return new TimeHeaderQuarterly(stringBounder, thParam(), printStart);
else if (printScale == PrintScale.YEARLY)
return new TimeHeaderYearly(stringBounder, thParam(), printStart);
else
throw new IllegalStateException();
}
private TimeHeaderParameters thParam() {
return new TimeHeaderParameters(colorDays(), getFactorScale(), min, max, getIHtmlColorSet(), locale, openClose,
colorDaysOfWeek, verticalSeparatorBefore, this);
}
private Map colorDays() {
colorDaysInternal.putAll(colorDaysToday);
return Collections.unmodifiableMap(colorDaysInternal);
}
@Override
public final Style getStyle(SName param) {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, param)
.getMergedStyle(getCurrentStyleBuilder());
}
@Override
public final Style getStyle(SName param1, SName param2) {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, param1, param2)
.getMergedStyle(getCurrentStyleBuilder());
}
private double getTotalHeight(StringBounder stringBounder, TimeHeader timeHeader) {
if (showFootbox)
return totalHeightWithoutFooter + timeHeader.getTimeFooterHeight(stringBounder);
return totalHeightWithoutFooter;
}
private void drawTasksRect(UGraphic ug) {
for (Task task : tasks.values()) {
if (isHidden(task))
continue;
final TaskDraw draw = draws.get(task);
final UTranslate move = UTranslate.dy(draw.getY(ug.getStringBounder()).getCurrentValue());
draw.drawU(ug.apply(move));
}
}
private void drawConstraints(final UGraphic ug, TimeScale timeScale) {
for (GanttConstraint constraint : constraints) {
if (printStart != null && constraint.isHidden(min, max))
continue;
constraint.getUDrawable(timeScale, this).drawU(ug);
}
}
public StyleSignatureBasic getDefaultStyleDefinitionArrow() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.arrow);
}
private void drawTasksTitle(UGraphic ug, double colTitles, double colBars) {
for (Task task : tasks.values()) {
if (isHidden(task))
continue;
final TaskDraw draw = draws.get(task);
final UTranslate move = UTranslate.dy(draw.getY(ug.getStringBounder()).getCurrentValue());
draw.drawTitle(ug.apply(move), labelStrategy, colTitles, colBars);
}
}
private void drawResources(UGraphic ug) {
for (Resource res : resources.values()) {
final ResourceDraw draw = res.getResourceDraw();
final UTranslate move = UTranslate.dy(draw.getY());
draw.drawU(ug.apply(move));
}
}
public void closeDayOfWeek(DayOfWeek day, String task) {
openClose.close(day);
}
public void openDayOfWeek(DayOfWeek day, String task) {
if (task.length() == 0)
openClose.open(day);
else
getOpenCloseForTask(task).open(day);
}
public void closeDayAsDate(Day day, String task) {
if (task.length() == 0)
openClose.close(day);
else
getOpenCloseForTask(task).close(day);
}
public void openDayAsDate(Day day, String task) {
if (task.length() == 0)
openClose.open(day);
else
getOpenCloseForTask(task).open(day);
}
private OpenClose getOpenCloseForTask(String task) {
OpenClose except = openCloseForTask.get(task);
if (except == null) {
except = new OpenClose();
openCloseForTask.put(task, except);
}
return except;
}
private final Map openCloseForTask = new HashMap<>();
private void initTaskAndResourceDraws(TimeScale timeScale, double headerHeight, StringBounder stringBounder) {
Real y = origin.addFixed(headerHeight);
for (Task task : tasks.values()) {
final TaskDraw draw;
if (task instanceof TaskSeparator) {
final TaskSeparator taskSeparator = (TaskSeparator) task;
draw = new TaskDrawSeparator(taskSeparator.getName(), timeScale, y, min, max, task.getStyleBuilder(),
getSkinParam().getIHtmlColorSet());
} else if (task instanceof TaskGroup) {
final TaskGroup taskGroup = (TaskGroup) task;
draw = new TaskDrawGroup(timeScale, y, taskGroup.getCode().getDisplay(), getStart(taskGroup),
getEnd(taskGroup), task, this, task.getStyleBuilder());
} else {
final TaskImpl tmp = (TaskImpl) task;
final String disp = hideResourceName ? tmp.getCode().getDisplay() : tmp.getPrettyDisplay();
if (tmp.isDiamond()) {
draw = new TaskDrawDiamond(timeScale, y, disp, getStart(tmp), task, this, task.getStyleBuilder());
} else {
final boolean oddStart = printStart != null && min.compareTo(getStart(tmp)) == 0;
final boolean oddEnd = printStart != null && max.compareTo(getEnd(tmp)) == 0;
draw = new TaskDrawRegular(timeScale, y, disp, getStart(tmp), getEnd(tmp), oddStart, oddEnd,
getSkinParam(), task, this, getConstraints(task), task.getStyleBuilder());
}
draw.setColorsAndCompletion(tmp.getColors(), tmp.getCompletion(), tmp.getUrl(), tmp.getNote());
}
if (task.getRow() == null)
y = y.addAtLeast(draw.getFullHeightTask(stringBounder));
draws.put(task, draw);
}
origin.compileNow();
magicPush(stringBounder);
double yy = lastY(stringBounder);
if (yy == 0) {
yy = headerHeight;
} else if (this.hideResourceFoobox == false)
for (Resource res : resources.values()) {
final ResourceDraw draw = buildResourceDraw(this, res, timeScale, yy, min, max);
res.setTaskDraw(draw);
yy += draw.getHeight(stringBounder);
}
this.totalHeightWithoutFooter = yy;
}
private ResourceDraw buildResourceDraw(GanttDiagram gantt, Resource res, TimeScale timeScale, double y, Day min,
Day max) {
return new ResourceDrawBasic(gantt, res, timeScale, y, min, max);
// return new ResourceDrawVersion2(gantt, res, timeScale, y, min, max);
}
private Collection getConstraints(Task task) {
final List result = new ArrayList<>();
for (GanttConstraint constraint : constraints) {
if (constraint.isOn(task))
result.add(constraint);
}
return Collections.unmodifiableCollection(result);
}
private double lastY(StringBounder stringBounder) {
double result = 0;
for (TaskDraw td : draws.values())
result = Math.max(result, td.getY(stringBounder).getCurrentValue() + td.getHeightMax(stringBounder));
return result;
}
private void magicPush(StringBounder stringBounder) {
final List notes = new ArrayList<>();
for (TaskDraw td : draws.values()) {
final FingerPrint taskPrint = td.getFingerPrint(stringBounder);
final FingerPrint fingerPrintNote = td.getFingerPrintNote(stringBounder);
if (td.getTrueRow() == null)
for (TaskDraw note : notes) {
final FingerPrint otherNote = note.getFingerPrintNote(stringBounder);
final double deltaY = otherNote.overlap(taskPrint);
if (deltaY > 0) {
final Real bottom = note.getY(stringBounder).addAtLeast(note.getHeightMax(stringBounder));
td.getY(stringBounder).ensureBiggerThan(bottom);
origin.compileNow();
}
}
if (fingerPrintNote != null)
notes.add(td);
}
}
private Day getStart(final Task tmp) {
if (printStart == null)
return tmp.getStart();
return Day.max(min, tmp.getStart());
}
private Day getEnd(final Task tmp) {
if (printStart == null)
return tmp.getEnd();
return Day.min(max, tmp.getEnd());
}
private void initMinMax() {
if (tasks.size() == 0) {
max = min.increment();
} else {
max = null;
for (Task task : tasks.values()) {
if (task instanceof TaskSeparator || task instanceof TaskGroup)
continue;
final Day start = task.getStart();
final Day end = task.getEnd();
// if (min.compareTo(start) > 0) {
// min = start;
// }
if (max == null || max.compareTo(end) < 0)
max = end;
}
}
if (openClose.getStartingDay() != null) {
for (Day d : colorDays().keySet())
if (d.compareTo(max) > 0)
max = d;
for (Day d : nameDays.keySet())
if (d.compareTo(max) > 0)
max = d;
}
}
public Day getThenDate() {
Day result = getStartingDate();
for (Day d : colorDays().keySet())
if (d.compareTo(result) > 0)
result = d;
for (Day d : nameDays.keySet())
if (d.compareTo(result) > 0)
result = d;
return result;
}
public Task getExistingTask(String id) {
final TaskCode code = TaskCode.fromId(Objects.requireNonNull(id));
return tasks.get(code);
}
public GanttConstraint forceTaskOrder(Task task1, Task task2) {
final TaskInstant end1 = new TaskInstant(task1, TaskAttribute.END);
task2.setStart(end1.getInstantPrecise());
final GanttConstraint result = new GanttConstraint(this.getIHtmlColorSet(),
getSkinParam().getCurrentStyleBuilder(), end1, new TaskInstant(task2, TaskAttribute.START));
addContraint(result);
return result;
}
public Task getOrCreateTask(TaskCode code, boolean linkedToPrevious) {
Task result = tasks.get(Objects.requireNonNull(code));
if (result == null) {
Task previous = null;
if (linkedToPrevious)
previous = getLastCreatedTask();
final OpenClose except = this.openCloseForTask.get(code.getId());
result = new TaskImpl(getSkinParam().getCurrentStyleBuilder(), code, openClose.mutateMe(except),
openClose.getStartingDay(), defaultCompletion);
if (currentGroup != null)
currentGroup.addTask(result);
tasks.put(code, result);
if (previous != null)
forceTaskOrder(previous, result);
}
return result;
}
private Task getLastCreatedTask() {
final List all = new ArrayList<>(tasks.values());
for (int i = all.size() - 1; i >= 0; i--)
if (all.get(i) instanceof TaskImpl)
return all.get(i);
return null;
}
public void addSeparator(String comment) {
TaskSeparator separator = new TaskSeparator(getSkinParam().getCurrentStyleBuilder(), comment, tasks.size());
tasks.put(separator.getCode(), separator);
}
private TaskGroup currentGroup = null;
public CommandExecutionResult addGroup(TaskCode code) {
TaskGroup group = new TaskGroup(this.currentGroup, getSkinParam().getCurrentStyleBuilder(), code);
if (this.currentGroup != null)
this.currentGroup.addTask(group);
this.currentGroup = group;
tasks.put(group.getCode(), group);
return CommandExecutionResult.ok();
}
public CommandExecutionResult endGroup() {
if (this.currentGroup == null)
return CommandExecutionResult.error("No group to be closed");
this.currentGroup = this.currentGroup.getParent();
return CommandExecutionResult.ok();
}
public void addContraint(GanttConstraint constraint) {
constraints.add(constraint);
}
public HColorSet getIHtmlColorSet() {
return colorSet;
}
public void setProjectStartingDate(Day start) {
openClose.setStartingDay(start);
this.min = start;
}
public Day getStartingDate() {
if (openClose.getStartingDay() == null)
return min;
return openClose.getStartingDay();
}
public Day getEndingDate() {
initMinMax();
return max;
}
public int daysInWeek() {
return openClose.daysInWeek();
}
public boolean isOpen(Day day) {
return openClose.getLoadAt(day) > 0;
}
public boolean affectResource(Task result, String description) {
final Pattern p = Pattern.compile("([^:]+)(:(\\d+))?");
final Matcher m = p.matcher(description);
if (m.find() == false)
throw new IllegalArgumentException();
final Resource resource = getResource(m.group(1));
int percentage = 100;
if (m.group(3) != null)
percentage = Integer.parseInt(m.group(3));
if (percentage == 0)
return false;
result.addResource(resource, percentage);
return true;
}
public Resource getResource(String resourceName) {
Resource resource = resources.get(resourceName);
if (resource == null)
resource = new Resource(resourceName);
resources.put(resourceName, resource);
return resource;
}
public int getLoadForResource(Resource res, Day i) {
int result = 0;
for (Task task : tasks.values()) {
if (task instanceof TaskSeparator)
continue;
final TaskImpl task2 = (TaskImpl) task;
result += task2.loadForResource(res, i);
}
return result;
}
public Moment getExistingMoment(String id) {
Moment result = getExistingTask(id);
if (result == null) {
Day start = null;
Day end = null;
for (Map.Entry ent : nameDays.entrySet()) {
if (ent.getValue().equalsIgnoreCase(id) == false)
continue;
start = min(start, ent.getKey());
end = max(end, ent.getKey());
}
if (start != null)
result = new MomentImpl(start, end);
}
return result;
}
private Day min(Day d1, Day d2) {
if (d1 == null)
return d2;
if (d1.compareTo(d2) > 0)
return d2;
return d1;
}
private Day max(Day d1, Day d2) {
if (d1 == null)
return d2;
if (d1.compareTo(d2) < 0)
return d2;
return d1;
}
public void colorDay(Day day, HColor color) {
colorDaysInternal.put(day, color);
}
public void colorDay(DayOfWeek day, HColor color) {
colorDaysOfWeek.put(day, color);
}
public void nameDay(Day day, String name) {
nameDays.put(day, name);
}
public Day getToday() {
if (today == null)
this.today = Day.today();
return today;
}
public void setTodayColors(CenterBorderColor colors) {
if (today == null)
this.today = Day.today();
colorDaysToday.put(today, colors.getCenter());
}
public CommandExecutionResult setToday(Day date) {
this.today = date;
return CommandExecutionResult.ok();
}
public CommandExecutionResult deleteTask(Task task) {
task.setColors(new CenterBorderColor(HColors.WHITE, HColors.BLACK));
return CommandExecutionResult.ok();
}
public void setPrintInterval(Day start, Day end) {
this.printStart = start;
this.printEnd = end;
}
public TaskDraw getTaskDraw(Task task) {
return draws.get(task);
}
public CommandExecutionResult addNote(Display note) {
Task last = null;
for (Task current : tasks.values())
last = current;
if (last == null)
return CommandExecutionResult.error("No task defined");
last.setNote(note);
return CommandExecutionResult.ok();
}
public LoadPlanable getDefaultPlan() {
return openClose;
}
private boolean showFootbox = true;
public void setShowFootbox(boolean footbox) {
this.showFootbox = footbox;
}
@Override
public ClockwiseTopRightBottomLeft getDefaultMargins() {
return ClockwiseTopRightBottomLeft.none();
}
public void setLabelStrategy(LabelStrategy strategy) {
this.labelStrategy = strategy;
}
private WeeklyHeaderStrategy weeklyHeaderStrategy;
public void setWeeklyHeaderStrategy(WeeklyHeaderStrategy weeklyHeaderStrategy) {
this.weeklyHeaderStrategy = weeklyHeaderStrategy;
}
private boolean hideResourceName;
private boolean hideResourceFoobox;
public CommandExecutionResult hideResourceName() {
this.hideResourceName = true;
return CommandExecutionResult.ok();
}
public CommandExecutionResult hideResourceFootbox() {
this.hideResourceFoobox = true;
return CommandExecutionResult.ok();
}
private final Set verticalSeparatorBefore = new HashSet<>();
public void addVerticalSeparatorBefore(Day day) {
verticalSeparatorBefore.add(day);
}
public void setTaskDefaultCompletion(int defaultCompletion) {
this.defaultCompletion = defaultCompletion;
}
public List getAllTasksForResource(Resource res) {
final List result = new ArrayList();
for (Task task : tasks.values())
if (task.isAssignedTo(res)) {
final TaskDrawRegular draw = (TaskDrawRegular) draws.get(task);
result.add(draw);
}
return Collections.unmodifiableList(result);
}
public void setIt(Task result) {
this.it = result;
}
public Task getIt() {
return it;
}
public final Resource getThey() {
return they;
}
public final void setThey(Resource they) {
this.they = they;
}
}