edu.cmu.tetrad.util.AlgorithmDescriptions Maven / Gradle / Ivy
/*
* Copyright (C) 2017 University of Pittsburgh.
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301 USA
*/
package edu.cmu.tetrad.util;
import edu.cmu.tetrad.annotation.AlgorithmAnnotations;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
/**
* Algorithm descriptions.
*
* @author Zhou Yuan [email protected]
* @author Kevin V. Bui ([email protected])
*/
public class AlgorithmDescriptions {
// private static final Logger LOGGER = LoggerFactory.getLogger(AlgorithmDescriptions.class);
private static final AlgorithmDescriptions INSTANCE = new AlgorithmDescriptions();
private final Map descriptions = new HashMap<>();
private AlgorithmDescriptions() {
try (InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("manual/index.html")) {
Document doc = Jsoup.parse(inputStream, StandardCharsets.UTF_8.name(), "");
getShortNames().forEach(shortName -> {
Element element = doc.getElementById(shortName);
if (element != null) {
Elements paragraphs = element.children();
String desc = paragraphs.stream()
.map(p -> p.text().trim())
.collect(Collectors.joining("\n"));
this.descriptions.put(shortName, desc);
}
});
} catch (IOException ex) {
TetradLogger.getInstance().forceLogMessage("Failed to read tetrad HTML manual 'maunal/index.html' file from within the jar.");
}
}
/**
* Gets the instance of this class.
* @return instance of this class
*/
public static AlgorithmDescriptions getInstance() {
return AlgorithmDescriptions.INSTANCE;
}
/**
* Gets the description of the algorithm.
* @param shortName short name of the algorithm
* @return description of the algorithm
*/
public String get(String shortName) {
String description = this.descriptions.get(shortName);
return (description == null)
? String.format("Please add a description for %s.", shortName)
: description;
}
private List getShortNames() {
// get algorithm from annotations
List shortNames = AlgorithmAnnotations.getInstance().getAnnotatedClasses().stream()
.map(e -> e.getAnnotation().command())
.collect(Collectors.toList());
// add additional shortNames not annotated
shortNames.add("cpc"); // conservative PC
return shortNames;
}
}