mirror of
https://github.com/sismics/docs.git
synced 2024-06-14 14:01:23 +02:00
92 lines
3.7 KiB
Java
92 lines
3.7 KiB
Java
package com.sismics.util;
|
|
|
|
import org.jsoup.internal.StringUtil;
|
|
import org.jsoup.nodes.Element;
|
|
import org.jsoup.nodes.Node;
|
|
import org.jsoup.nodes.TextNode;
|
|
import org.jsoup.select.NodeTraversor;
|
|
import org.jsoup.select.NodeVisitor;
|
|
|
|
/**
|
|
* HTML to plain-text. This example program demonstrates the use of jsoup to convert HTML input to lightly-formatted
|
|
* plain-text. That is divergent from the general goal of jsoup's .text() methods, which is to get clean data from a
|
|
* scrape.
|
|
*
|
|
* @author Jonathan Hedley, jonathan@hedley.net
|
|
*/
|
|
public class HtmlToPlainText {
|
|
/**
|
|
* Format an Element to plain-text
|
|
* @param element the root element to format
|
|
* @return formatted text
|
|
*/
|
|
public String getPlainText(Element element) {
|
|
FormattingVisitor formatter = new FormattingVisitor();
|
|
NodeTraversor.traverse(formatter, element); // walk the DOM, and call .head() and .tail() for each node
|
|
|
|
return formatter.toString();
|
|
}
|
|
|
|
// the formatting rules, implemented in a breadth-first DOM traverse
|
|
static private class FormattingVisitor implements NodeVisitor {
|
|
private static final int maxWidth = 80;
|
|
private int width = 0;
|
|
private StringBuilder accum = new StringBuilder(); // holds the accumulated text
|
|
|
|
// hit when the node is first seen
|
|
public void head(Node node, int depth) {
|
|
String name = node.nodeName();
|
|
if (node instanceof TextNode)
|
|
append(((TextNode) node).text()); // TextNodes carry all user-readable text in the DOM.
|
|
else if (name.equals("li"))
|
|
append("\n * ");
|
|
else if (name.equals("dt"))
|
|
append(" ");
|
|
else if (StringUtil.in(name, "p", "h1", "h2", "h3", "h4", "h5", "tr"))
|
|
append("\n");
|
|
}
|
|
|
|
// hit when all of the node's children (if any) have been visited
|
|
public void tail(Node node, int depth) {
|
|
String name = node.nodeName();
|
|
if (StringUtil.in(name, "br", "dd", "dt", "p", "h1", "h2", "h3", "h4", "h5"))
|
|
append("\n");
|
|
else if (name.equals("a"))
|
|
append(String.format(" <%s>", node.absUrl("href")));
|
|
}
|
|
|
|
// appends text to the string builder with a simple word wrap method
|
|
private void append(String text) {
|
|
if (text.startsWith("\n"))
|
|
width = 0; // reset counter if starts with a newline. only from formats above, not in natural text
|
|
if (text.equals(" ") &&
|
|
(accum.length() == 0 || StringUtil.in(accum.substring(accum.length() - 1), " ", "\n")))
|
|
return; // don't accumulate long runs of empty spaces
|
|
|
|
if (text.length() + width > maxWidth) { // won't fit, needs to wrap
|
|
String[] words = text.split("\\s+");
|
|
for (int i = 0; i < words.length; i++) {
|
|
String word = words[i];
|
|
boolean last = i == words.length - 1;
|
|
if (!last) // insert a space if not the last word
|
|
word = word + " ";
|
|
if (word.length() + width > maxWidth) { // wrap and reset counter
|
|
accum.append("\n").append(word);
|
|
width = word.length();
|
|
} else {
|
|
accum.append(word);
|
|
width += word.length();
|
|
}
|
|
}
|
|
} else { // fits as is, without need to wrap text
|
|
accum.append(text);
|
|
width += text.length();
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
return accum.toString();
|
|
}
|
|
}
|
|
} |