openllet.profiler.utils.ObjectProfileVisitors Maven / Gradle / Ivy
package openllet.profiler.utils;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.text.DecimalFormat;
import java.text.NumberFormat;
// ----------------------------------------------------------------------------
/**
* A Factory for a few stock _node visitors. See the implementation for details.
*
* @author (C) Vlad Roubtsov, 2003
*/
public abstract class ObjectProfileVisitors
{
// public: ................................................................
/**
* Factory method for creating the default plain text _node _node print visitor. It is up to the caller to buffer 'out'.
*
* @param out writer to dump the _nodes into [may not be null]
* @param indent indent increment string [null is equivalent to " "]
* @param format percentage formatter to use [null is equivalent to NumberFormat.getPercentInstance (), with a single fraction digit]
* @param shortClassNames 'true' causes all class names to be dumped in compact [no package prefix] form
*/
public static ObjectProfileNode.INodeVisitor newDefaultNodePrinter(final PrintWriter out, final String indent, final DecimalFormat format, final boolean shortClassNames)
{
return new DefaultNodePrinter(out, indent, format, shortClassNames);
}
/**
* Factory method for creating the XML output visitor. To create a valid XML document, start the traversal on the profile root _node. It is up to the caller
* to buffer 'out'.
*
* @param out stream to dump the _nodes into [may not be null]
* @param indent indent increment string [null is equivalent to " "]
* @param format percentage formatter to use [null is equivalent to NumberFormat.getPercentInstance (), with a single fraction digit]
* @param shortClassNames 'true' causes all class names to be dumped in compact [no package prefix] form
*/
public static ObjectProfileNode.INodeVisitor newXMLNodePrinter(final OutputStream out, final String indent, final DecimalFormat format, final boolean shortClassNames)
{
return new XMLNodePrinter(out, indent, format, shortClassNames);
}
// protected: .............................................................
// package: ...............................................................
// private: ...............................................................
private ObjectProfileVisitors()
{
} // this class is not extendible
private static abstract class AbstractProfileNodeVisitor implements IObjectProfileNode.INodeVisitor
{
@Override
public void previsit(final IObjectProfileNode node)
{
// Nothing to do
}
@Override
public void postvisit(final IObjectProfileNode node)
{
// Nothing to do
}
} // _end of nested class
/**
* This visitor prints out a _node in plain text format. The output is indented according to the length of the _node's path within its profile tree.
*/
private static final class DefaultNodePrinter extends AbstractProfileNodeVisitor
{
@Override
public void previsit(final IObjectProfileNode node)
{
final StringBuffer sb = new StringBuffer();
for (int p = 0, pLimit = node.pathlength(); p < pLimit; ++p)
sb.append(_indent);
final IObjectProfileNode root = node.root();
sb.append(node.size());
if (node != root) // root _node is always 100% of the overall size
{
sb.append(" (");
sb.append(_format.format((double) node.size() / root.size()));
sb.append(")");
}
sb.append(" -> ");
sb.append(node.name());
if (node.object() != null) // skip shell pseudo-_nodes
{
sb.append(" : ");
sb.append(ObjectProfiler.typeName(node.object().getClass(), _shortClassNames));
if (node.refcount() > 1) // show refcount only when it's > 1
{
sb.append(", refcount=");
sb.append(node.refcount());
}
}
_out.println(sb);
_out.flush();
}
DefaultNodePrinter(final PrintWriter out, final String indent, final DecimalFormat format, final boolean shortClassNames)
{
assert out != null : "null input: out";
_out = out;
_indent = indent != null ? indent : " ";
if (format != null)
_format = format;
else
{
_format = (DecimalFormat) NumberFormat.getPercentInstance();
_format.setMaximumFractionDigits(1);
}
_shortClassNames = shortClassNames;
}
private final PrintWriter _out;
private final String _indent;
private final DecimalFormat _format;
private final boolean _shortClassNames;
} // _end of nested class
/*
* This visitor can dump a profile tree in an XML file, which can be handy
* for examination of very large object graphs.
*/
private static final class XMLNodePrinter extends AbstractProfileNodeVisitor
{
@Override
public void previsit(final IObjectProfileNode node)
{
final IObjectProfileNode root = node.root();
final boolean isRoot = root == node;
if (isRoot)
{
_out.println("");
_out.println("");
}
final StringBuffer indent = new StringBuffer();
for (int p = 0, pLimit = node.pathlength(); p < pLimit; ++p)
indent.append(_indent);
final StringBuffer sb = new StringBuffer();
sb.append(" 1)
{
sb.append(" refcount=\"");
sb.append(node.refcount());
sb.append('\"');
}
}
sb.append('>');
_out.print(indent);
_out.println(sb);
}
@Override
public void postvisit(final IObjectProfileNode node)
{
final StringBuffer indent = new StringBuffer();
for (int p = 0, pLimit = node.pathlength(); p < pLimit; ++p)
indent.append(_indent);
_out.print(indent);
_out.println("");
if (node.root() == node)
{
_out.println("");
_out.flush();
}
}
XMLNodePrinter(final OutputStream out, final String indent, final DecimalFormat format, final boolean shortClassNames)
{
assert out != null : "null input: out";
try
{
_out = new PrintWriter(new OutputStreamWriter(out, ENCODING));
}
catch (final UnsupportedEncodingException uee)
{
throw new Error(uee);
}
_indent = indent != null ? indent : " ";
if (format != null)
_format = format;
else
{
_format = (DecimalFormat) NumberFormat.getPercentInstance();
_format.setMaximumFractionDigits(2);
}
_shortClassNames = shortClassNames;
}
private static void XMLEscape(final String s, final StringBuffer append)
{
final char[] chars = s.toCharArray();
for (int i = 0, iLimit = s.length(); i < iLimit; ++i)
{
final char c = chars[i];
switch (c)
{
case '<':
append.append("<");
break;
case '>':
append.append(">");
break;
case '"':
append.append(""");
break;
case '&':
append.append("&");
break;
default:
append.append(c);
} // _end of switch
}
}
private final PrintWriter _out;
private final String _indent;
private final DecimalFormat _format;
private final boolean _shortClassNames;
private static final String ENCODING = "UTF-8";
} // _end of nested class
} // _end of class
// ---------------------------------------------------------------------------- © 2015 - 2025 Weber Informatics LLC | Privacy Policy