net.sourceforge.plantuml.stats.XmlConverter Maven / Gradle / Ivy
Show all versions of plantuml-epl Show documentation
// 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this EPL license.
*
* The generated images can then be used without any reference to the EPL license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.stats;
import java.io.OutputStream;
import java.text.DateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import net.sourceforge.plantuml.stats.api.Stats;
import net.sourceforge.plantuml.stats.api.StatsColumn;
import net.sourceforge.plantuml.stats.api.StatsLine;
import net.sourceforge.plantuml.stats.api.StatsTable;
import net.sourceforge.plantuml.text.BackSlash;
import net.sourceforge.plantuml.xml.XmlFactories;
public class XmlConverter {
private final DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM);
private final Stats stats;
public XmlConverter(Stats stats) {
this.stats = stats;
}
private Document getDocument() throws ParserConfigurationException {
final DocumentBuilder builder = XmlFactories.newDocumentBuilder();
final Document document = builder.newDocument();
document.setXmlStandalone(true);
final Element root = (Element) document.createElement("plantuml".toUpperCase());
document.appendChild(root);
// final Element elt1 = (Element)
// document.createElement("totalLaunch".toUpperCase());
// elt1.setTextContent("" + stats.totalLaunch());
// root.appendChild(elt1);
addNode(root, document, stats.getLastSessions());
addNode(root, document, stats.getCurrentSessionByDiagramType());
addNode(root, document, stats.getCurrentSessionByFormat());
addNode(root, document, stats.getAllByDiagramType());
addNode(root, document, stats.getAllByFormat());
return document;
}
private void addNode(Element root, Document document, StatsTable table) {
final Element elt = (Element) document.createElement(toXmlName(table.getName()).toUpperCase());
for (StatsLine statsLine : table.getLines()) {
final Element line = (Element) document.createElement("line".toUpperCase());
for (StatsColumn col : table.getColumnHeaders()) {
final Element value = (Element) document.createElement(col.name());
// value.setAttribute("value", toText(statsLine.getValue(col)));
value.setTextContent(toText(statsLine.getValue(col)));
line.appendChild(value);
}
elt.appendChild(line);
}
root.appendChild(elt);
}
private String toXmlName(String name) {
return name.replaceAll("\\W+", "_");
}
private String toText(Object tmp) {
if (tmp instanceof Date) {
return "" + ((Date) tmp).getTime();
}
if (tmp == null) {
return "";
}
return tmp.toString();
}
private Transformer getTransformer() throws TransformerException {
final Transformer transformer = XmlFactories.newTransformer();
transformer.setOutputProperty(OutputKeys.STANDALONE, "yes");
return transformer;
}
public void createXml(OutputStream os) throws TransformerException, ParserConfigurationException {
final DOMSource source = new DOMSource(getDocument());
final StreamResult scrResult = new StreamResult(os);
getTransformer().transform(source, scrResult);
}
public String toHtml() {
final StringBuilder result = new StringBuilder();
result.append("");
result.append("");
result.append("Statistics
");
printTableHtml(result, stats.getLastSessions());
result.append("Current session statistics
");
printTableHtml(result, stats.getCurrentSessionByDiagramType());
result.append("");
printTableHtml(result, stats.getCurrentSessionByFormat());
result.append("
General statistics since ever
");
printTableHtml(result, stats.getAllByDiagramType());
result.append("");
printTableHtml(result, stats.getAllByFormat());
result.append("");
return result.toString();
}
private void printTableHtml(StringBuilder result, StatsTable table) {
final Collection headers = table.getColumnHeaders();
result.append("");
result.append(getHtmlHeader(headers));
final List lines = table.getLines();
for (int i = 0; i < lines.size(); i++) {
final StatsLine line = lines.get(i);
final boolean bold = i == lines.size() - 1;
result.append(getCreoleLine(headers, line, bold));
}
result.append("
");
}
private String getCreoleLine(Collection headers, StatsLine line, boolean bold) {
final StringBuilder result = new StringBuilder();
if (bold) {
result.append("");
} else {
result.append(" ");
}
for (StatsColumn col : headers) {
final Object v = line.getValue(col);
if (v instanceof Long || v instanceof HumanDuration) {
result.append("");
} else {
result.append(" ");
}
if (bold) {
result.append("");
}
if (v instanceof Long) {
result.append(String.format("%,d", v));
} else if (v instanceof Date) {
result.append(formatter.format(v));
} else if (v == null || v.toString().length() == 0) {
result.append(" ");
} else {
result.append(v.toString());
}
if (bold) {
result.append("");
}
result.append(" ");
}
result.append(" ");
return result.toString();
}
private String getHtmlHeader(Collection headers) {
final StringBuilder sb = new StringBuilder();
sb.append("");
for (StatsColumn col : headers) {
sb.append("");
sb.append(col.getTitle().replace(BackSlash.BS_BS_N, "
"));
sb.append(" ");
}
sb.append(" ");
return sb.toString();
}
}