io.github.oliviercailloux.grade.format.HtmlGrades Maven / Gradle / Ivy
The newest version!
package io.github.oliviercailloux.grade.format;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Verify.verify;
import com.google.common.base.VerifyException;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.MoreCollectors;
import com.google.common.math.Stats;
import io.github.oliviercailloux.grade.AbsoluteAggregator;
import io.github.oliviercailloux.grade.CriteriaWeighter;
import io.github.oliviercailloux.grade.Criterion;
import io.github.oliviercailloux.grade.Grade;
import io.github.oliviercailloux.grade.Mark;
import io.github.oliviercailloux.grade.MarkAggregator;
import io.github.oliviercailloux.grade.MaxAggregator;
import io.github.oliviercailloux.grade.MinAggregator;
import io.github.oliviercailloux.grade.OwaAggregator;
import io.github.oliviercailloux.grade.OwaWeighter;
import io.github.oliviercailloux.grade.ParametricWeighter;
import io.github.oliviercailloux.grade.StaticWeighter;
import io.github.oliviercailloux.grade.SubGrade;
import io.github.oliviercailloux.xml.HtmlDocument;
import java.net.URI;
import java.text.NumberFormat;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import org.w3c.dom.Document;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Element;
public class HtmlGrades {
private static final double DEFAULT_DENOMINATOR = 20d;
private static final NumberFormat FORMATTER = NumberFormat.getNumberInstance(Locale.ENGLISH);
public static HtmlGrades newInstance() {
return new HtmlGrades();
}
public static Document asHtml(Grade grade, String title, double denominator) {
final HtmlGrades htmler = newInstance();
htmler.setTitle(title);
htmler.setDenominator(denominator);
return htmler.asHtmlDoc(grade);
}
public static Document asHtml(Map grades, String generalTitle,
double denominator) {
final HtmlDocument document = HtmlDocument.newInstance();
document.setTitle(generalTitle);
document.getBody().appendChild(document.createTitle1(generalTitle));
for (String key : grades.keySet()) {
final Grade grade = grades.get(key);
document.getBody().appendChild(document.createTitle2(key));
document.getBody().appendChild(
getDescription(new SubGrade(Criterion.given("Grade"), grade), document, denominator));
}
return document.getDocument();
}
public static Document asHtmlGrades(Map grades, String generalTitle,
double denominator) {
final HtmlDocument document = HtmlDocument.newInstance();
document.setTitle(generalTitle);
document.getBody().appendChild(document.createTitle1(generalTitle));
for (String key : grades.keySet()) {
final Grade grade = grades.get(key);
document.getBody().appendChild(document.createTitle2(key));
document.getBody().appendChild(
getDescription(new SubGrade(Criterion.given("Grade"), grade), document, denominator));
}
return document.getDocument();
}
private static DocumentFragment getDescription(SubGrade critGrade, HtmlDocument document,
double denominator) {
checkNotNull(critGrade);
checkNotNull(document);
final DocumentFragment fragment = document.getDocument().createDocumentFragment();
final Criterion criterion = critGrade.criterion();
final Grade grade = critGrade.grade();
final Mark mark = grade.mark();
final String comment = mark.getComment();
final String overDenominator =
denominator == 100d ? "%" : " / " + FORMATTER.format(denominator);
final String pointsText = FORMATTER.format(mark.getPoints() * denominator)
/* TODO */
+ (criterion.getName().equals("Itération 4 UML") ? "" : overDenominator);
final boolean isMark = grade.toMarksTree().isMark();
final String explanation;
if (isMark) {
explanation = comment;
} else {
checkArgument(comment.isEmpty(), comment);
final MarkAggregator aggregator = grade.getMarkAggregator();
if (aggregator instanceof ParametricWeighter a) {
final Grade multipliedGrade = grade.getGrade(a.multipliedCriterion());
final Grade weightingGrade = grade.getGrade(a.weightingCriterion());
final String basePointsText =
FORMATTER.format(multipliedGrade.mark().getPoints() * denominator) + overDenominator;
final String baseFactor =
" × " + FORMATTER.format(weightingGrade.mark().getPoints() * 100) + "%";
final Optional unknownGrade = unknown(grade).map(grade::getGrade);
final String unknownFactor =
" × " + FORMATTER.format(100d - weightingGrade.mark().getPoints() * 100) + "%";
final Optional unknownPoints =
unknownGrade.map(g -> " + " + FORMATTER.format(g.mark().getPoints() * denominator)
+ overDenominator + unknownFactor);
explanation = basePointsText + baseFactor + unknownPoints.orElse("");
} else if (aggregator instanceof AbsoluteAggregator) {
explanation = "Sum";
} else if (aggregator instanceof StaticWeighter) {
explanation = "Weighted sum";
} else if (aggregator instanceof MinAggregator) {
explanation = "Min";
} else if (aggregator instanceof MaxAggregator) {
explanation = "Max";
} else if (aggregator instanceof OwaAggregator o) {
/* TODO */
explanation = "Ordered weighted average with weights %s".formatted(o.weights());
} else {
throw new VerifyException();
}
}
final String explanationSeparator = explanation.isEmpty() ? "" : ": ";
final String criterionSumary =
criterion.getName() + " — " + explanation + explanationSeparator + pointsText;
fragment.appendChild(document.createParagraph(criterionSumary));
if (!isMark) {
final Element ul = document.createXhtmlElement("ul");
fragment.appendChild(ul);
final MarkAggregator aggregator = grade.getMarkAggregator();
if (aggregator instanceof ParametricWeighter) {
final ParametricWeighter a = (ParametricWeighter) aggregator;
final Optional unknown = unknown(grade);
{
final Criterion subCriterion = a.multipliedCriterion();
final Grade subGradeAsGrade = grade.getGrade(subCriterion);
final SubGrade subGrade = new SubGrade(subCriterion, subGradeAsGrade);
final DocumentFragment description = getDescription(subGrade, document, denominator);
final Element li = document.createXhtmlElement("li");
li.appendChild(description);
ul.appendChild(li);
}
{
final Criterion subCriterion = a.weightingCriterion();
final Grade subGradeAsGrade = grade.getGrade(subCriterion);
checkArgument(subGradeAsGrade.toMarksTree().isMark());
final SubGrade subGrade = new SubGrade(subCriterion, subGradeAsGrade);
final DocumentFragment description = getDescription(subGrade, document, 100d);
final Element li = document.createXhtmlElement("li");
li.appendChild(description);
ul.appendChild(li);
}
if (unknown.isPresent()) {
final Criterion subCriterion = unknown.orElseThrow();
final Grade subGradeAsGrade = grade.getGrade(subCriterion);
final SubGrade subGrade = new SubGrade(subCriterion, subGradeAsGrade);
final DocumentFragment description = getDescription(subGrade, document, denominator);
final Element li = document.createXhtmlElement("li");
li.appendChild(description);
ul.appendChild(li);
}
} else if (aggregator instanceof CriteriaWeighter || aggregator instanceof OwaAggregator) {
for (Criterion subCriterion : grade.toMarksTree().getCriteria()) {
final Grade subGradeAsGrade = grade.getGrade(subCriterion);
final SubGrade subGrade = new SubGrade(subCriterion, subGradeAsGrade);
final double subWeight = grade.getWeight(subCriterion);
final DocumentFragment description =
getDescription(subGrade, document, denominator * subWeight);
final Element li = document.createXhtmlElement("li");
li.appendChild(description);
ul.appendChild(li);
}
} else if (aggregator instanceof OwaWeighter) {
for (Criterion subCriterion : grade.toMarksTree().getCriteria()) {
final DocumentFragment description = getDescription(
new SubGrade(subCriterion, grade.getGrade(subCriterion)), document, denominator);
final Element li = document.createXhtmlElement("li");
li.appendChild(description);
ul.appendChild(li);
}
} else {
throw new VerifyException();
}
}
return fragment;
}
private static Optional unknown(Grade grade) {
final MarkAggregator aggregator = grade.getMarkAggregator();
final ParametricWeighter a = (ParametricWeighter) aggregator;
final ImmutableSet subCriteria = grade.toMarksTree().getCriteria();
verify(grade.toMarksTree().getCriteria().size() == 2
|| grade.toMarksTree().getCriteria().size() == 3);
final ImmutableSet known =
ImmutableSet.of(a.multipliedCriterion(), a.weightingCriterion());
verify(grade.toMarksTree().getCriteria().containsAll(known));
return subCriteria.stream().filter(c -> !known.contains(c))
.collect(MoreCollectors.toOptional());
}
private String title;
private double denominator;
private Stats stats;
private ImmutableMap quantiles;
private HtmlGrades() {
title = "";
denominator = DEFAULT_DENOMINATOR;
stats = null;
quantiles = ImmutableMap.of();
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = checkNotNull(title);
}
public double getDenominator() {
return denominator;
}
public void setDenominator(double denominator) {
checkArgument(denominator > 0d);
checkArgument(Double.isFinite(denominator));
this.denominator = denominator;
}
public Stats getStats() {
return stats;
}
public void setStats(Stats stats) {
checkArgument(stats == null || stats.count() >= 1);
this.stats = stats;
}
public ImmutableMap getQuantiles() {
return quantiles;
}
public void setQuantiles(Map quantiles) {
this.quantiles = ImmutableMap.copyOf(checkNotNull(quantiles));
}
public Document asHtmlDoc(Grade grade) {
final HtmlDocument document = HtmlDocument.newInstance();
document.setTitle(title);
final String introText = "Hi! This is an automated e-mail containing your grade: " + title;
document.getBody().appendChild(document.createParagraph(introText));
document.getBody().appendChild(
getDescription(new SubGrade(Criterion.given("Grade"), grade), document, denominator));
if (quantiles.containsKey(1) && quantiles.containsKey(2) && quantiles.containsKey(3)
&& stats != null) {
final Element p = document.createXhtmlElement("p");
p.appendChild(
document.createAnchor(URI.create("https://en.wikipedia.org/wiki/Quartile"), "Quartiles"));
final String quartilesString = ": [" + format(quantiles.get(1)) + " | "
+ format(quantiles.get(2)) + " | " + format(quantiles.get(3)) + "].";
p.appendChild(document.createTextNode(quartilesString));
p.appendChild(document.createTextNode(" Mean: " + format(stats.mean())));
if (stats.count() >= 2) {
p.appendChild(document.createTextNode("; "));
p.appendChild(document.createAnchor(URI.create(
"https://en.wikipedia.org/wiki/Standard_deviation#Corrected_sample_standard_deviation"),
"sd"));
p.appendChild(document.createTextNode(": " + format(stats.sampleStandardDeviation())));
}
p.appendChild(document.createTextNode("."));
document.getBody().appendChild(p);
}
return document.getDocument();
}
private String format(double pointsNormalized) {
return FORMATTER.format(pointsNormalized * denominator);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy