Package de.tsl2.nano.util

Class GraphLog

java.lang.Object

de.tsl2.nano.util.GraphLog

Direct Known Subclasses:

ActivityGraph

public class GraphLog
extends Object

Provides creation of text blocks to be interpreted by Gravizo and rendered with Graphviz inside a markdown text.

 Use:
   new GraphLog("mynodes").create(MyListOfNodes).write();
   
 this will create the file 'mymodes-graph.md.html'

Author:

Thomas Schneider

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	graph
protected String	name
protected Function<Object,String>	styler

Constructor Summary

Constructors

Constructor	Description
GraphLog(String name)
GraphLog(String name, Function<Object,String> styler)

Method Summary

Modifier and Type	Method	Description
GraphLog	add(Object node, Object dest, Object descriptor)
GraphLog	create(Iterable<? extends INode> nodes)
static void	createGraphFile(String name, Collection<? extends INode> elements, Function<Object,String> graphStyler)	convenience to create the graphlog and write the gravito file
String	getFileName()
protected String	gravizEnd()
protected String	gravizStart()
String	toString()
void	write()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

graph

protected StringBuilder graph

name

protected String name

styler

protected Function<Object,String> styler

Constructor Details

GraphLog

public GraphLog(String name)

GraphLog

public GraphLog(String name,
 Function<Object,String> styler)

Parameters:

name - name of graph. will be used inside the file name, too

styler - functional expression to add a styling like a color to the link (e.g.: d -> "color=" + cc.get((Integer)Math.round((int)d*10)))

Method Details

gravizStart

protected String gravizStart()

create

public GraphLog create(Iterable<? extends INode> nodes)

add

public GraphLog add(Object node,
 Object dest,
 Object descriptor)

toString

public String toString()

Overrides:

toString in class Object

gravizEnd

protected String gravizEnd()

write

public void write()

getFileName

public String getFileName()

createGraphFile

public static void createGraphFile(String name,
 Collection<? extends INode> elements,
 Function<Object,String> graphStyler)

convenience to create the graphlog and write the gravito file