Package org.openprovenance.prov.dot

Class ProvToDot

java.lang.Object

org.openprovenance.prov.dot.ProvToDot

public class ProvToDot
extends Object

Serialisation of Prov representation to DOT format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProvToDot.Config

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CONFIGURATION_FILE
static String	DEFAULT_CONFIGURATION_FILE_WITH_ROLE
static String	DEFAULT_CONFIGURATION_FILE_WITH_ROLE_NO_LABEL
int	MAX_TOOLTIP_LENGTH
static String	USAGE

Constructor Summary

Constructors

Constructor	Description
ProvToDot(ProvFactory pf)
ProvToDot(ProvFactory pf, boolean withRoleFlag)
ProvToDot(ProvFactory pf, String configurationFile)
ProvToDot(ProvFactory pf, String configurationFile, String other)
ProvToDot(ProvFactory pf, ProvToDot.Config config)

Method Summary

Modifier and Type	Method	Description
String	activityLabel(Activity p)
HashMap<String,String>	addActivityColor(Activity p, HashMap<String,String> properties)
HashMap<String,String>	addActivityLabel(Activity p, HashMap<String,String> properties)
HashMap<String,String>	addActivityShape(Activity p, HashMap<String,String> properties)
HashMap<String,String>	addAgentColor(Agent a, HashMap<String,String> properties)
HashMap<String,String>	addAgentLabel(Agent p, HashMap<String,String> properties)
HashMap<String,String>	addAgentShape(Agent p, HashMap<String,String> properties)
HashMap<String,String>	addAnnotationColor(HasOther ann, HashMap<String,String> properties)
HashMap<String,String>	addAnnotationLabel(HasOther ann, HashMap<String,String> properties)
HashMap<String,String>	addAnnotationLinkProperties(HasOther ann, HashMap<String,String> properties)
HashMap<String,String>	addAnnotationShape(HasOther ann, HashMap<String,String> properties)
HashMap<String,String>	addBlankNodeShape(HashMap<String,String> properties)
HashMap<String,String>	addColors(HasOther object, HashMap<String,String> properties)
HashMap<String,String>	addEntityColor(Entity a, HashMap<String,String> properties)
HashMap<String,String>	addEntityLabel(Entity p, HashMap<String,String> properties)
HashMap<String,String>	addEntityShape(Entity p, HashMap<String,String> properties)
HashMap<String,String>	addRelationAttributes(String accountLabel, Relation e, HashMap<String,String> properties)
void	addRelationLabel(Relation e0, HashMap<String,String> properties)
HashMap<String,String>	addURL(QualifiedName id, HashMap<String,String> properties)
String	agentColor(Agent p)
String	agentLabel(Agent p)
String	annotationColor(HasOther ann)
QualifiedName	annotationId(QualifiedName id, String node)
void	convert(Bundle bun, PrintStream out)
void	convert(Document graph, File file, String title)
void	convert(Document graph, OutputStream os, String title)
void	convert(Document graph, OutputStream os, String type, String title)
void	convert(Document doc, PrintStream out, String title)
void	convert(Document graph, String dotFile, OutputStream pdfStream, String title)
void	convert(Document graph, String dotFile, OutputStream os, String type, String title)
void	convert(Document graph, String dotFile, String title)
void	convert(Document graph, String dotFile, String pdfFile, String title)
void	convert(Document graph, String dotFile, String aFile, String type, String title)
String	convertAccount(String account)
String	convertActivityName(String process)
String	convertAgentName(String agent)
String	convertEntityName(String artifact)
String	convertProperty(Attribute oLabel)
String	convertRelationLabel(String label)
String	convertValue(Attribute v)
int	countOthers(HasOther ann)
String	displayRole(String role)
String	displaySize(HasOther p)
String	dotify(String name)
void	emitActivity(Activity p, PrintStream out)
void	emitAgent(Agent ag, PrintStream out)
void	emitAnnotations(String id, HasOther statement, PrintStream out)
void	emitAnnotations(HasOther node, PrintStream out)
void	emitBlankNode(String bnid, HashMap<String,String> properties, PrintStream out)
void	emitDependency(Relation e, PrintStream out)
void	emitElement(QualifiedName name, HashMap<String,String> properties, PrintStream out)
void	emitEntity(Entity a, PrintStream out)
void	emitProperties(StringBuffer sb, HashMap<String,String> properties)
void	emitRelation(String src, String dest, HashMap<String,String> properties, PrintStream out, boolean directional)
String	entityColor(Entity p)
String	entityLabel(Entity p)
ProvPrinterConfigDeserialiser	getDeserialiser()
String	getPropertyFromAny(Attribute o)
String	getPropertyValueFromAny(Attribute o)
String	getPropertyValueFromAny(Type t)
String	getPropertyValueWithUrl(Attribute t)
boolean	getRelationPrintRole(Relation edge)
String	getRelationStyle(Relation edge)
String	getStringValue(Other o)
String	htmlify(String name)
void	init(InputStream is)
void	init(String configurationFile)
void	init(ProvPrinterConfiguration configuration)
String	localnameToString(QualifiedName qName)
String	nonEmptyLocalName(QualifiedName name)
String	OLDdotify(String name)
String	processColor(Activity p)
String	qualifiedNameToString(QualifiedName qName)
String	selectColor(List<String> colors)
void	setLayout(String layout)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIGURATION_FILE

public static final String DEFAULT_CONFIGURATION_FILE

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_FILE_WITH_ROLE

public static final String DEFAULT_CONFIGURATION_FILE_WITH_ROLE

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_FILE_WITH_ROLE_NO_LABEL

public static final String DEFAULT_CONFIGURATION_FILE_WITH_ROLE_NO_LABEL

See Also:

Constant Field Values

USAGE

public static final String USAGE

See Also:

Constant Field Values

MAX_TOOLTIP_LENGTH

public int MAX_TOOLTIP_LENGTH

Constructor Detail

ProvToDot

public ProvToDot(ProvFactory pf)

ProvToDot

public ProvToDot(ProvFactory pf,
                 boolean withRoleFlag)

ProvToDot

public ProvToDot(ProvFactory pf,
                 ProvToDot.Config config)

ProvToDot

public ProvToDot(ProvFactory pf,
                 String configurationFile)

ProvToDot

public ProvToDot(ProvFactory pf,
                 String configurationFile,
                 String other)

Method Detail

qualifiedNameToString

public String qualifiedNameToString(QualifiedName qName)

localnameToString

public String localnameToString(QualifiedName qName)

getDeserialiser

public ProvPrinterConfigDeserialiser getDeserialiser()

init

public void init(String configurationFile)

init

public void init(InputStream is)

init

public void init(ProvPrinterConfiguration configuration)

convert

public void convert(Document graph,
                    String dotFile,
                    String pdfFile,
                    String title)
             throws FileNotFoundException,
                    IOException

Throws:

FileNotFoundException

IOException

convert

public void convert(Document graph,
                    String dotFile,
                    OutputStream pdfStream,
                    String title)
             throws FileNotFoundException,
                    IOException

Throws:

FileNotFoundException

IOException

convert

public void convert(Document graph,
                    String dotFile,
                    String title)
             throws FileNotFoundException,
                    IOException

Throws:

FileNotFoundException

IOException

convert

public void convert(Document graph,
                    String dotFile,
                    String aFile,
                    String type,
                    String title)
             throws FileNotFoundException,
                    IOException

Throws:

FileNotFoundException

IOException

convert

public void convert(Document graph,
                    OutputStream os,
                    String type,
                    String title)

convert

public void convert(Document graph,
                    String dotFile,
                    OutputStream os,
                    String type,
                    String title)
             throws FileNotFoundException,
                    IOException

Throws:

FileNotFoundException

IOException

convert

public void convert(Document graph,
                    File file,
                    String title)
             throws FileNotFoundException

Throws:

FileNotFoundException

convert

public void convert(Document graph,
                    OutputStream os,
                    String title)

convert

public void convert(Document doc,
                    PrintStream out,
                    String title)

convert

public void convert(Bundle bun,
                    PrintStream out)

emitAnnotations

public void emitAnnotations(HasOther node,
                            PrintStream out)

emitActivity

public void emitActivity(Activity p,
                         PrintStream out)

emitEntity

public void emitEntity(Entity a,
                       PrintStream out)

emitAgent

public void emitAgent(Agent ag,
                      PrintStream out)

emitAnnotations

public void emitAnnotations(String id,
                            HasOther statement,
                            PrintStream out)

annotationId

public QualifiedName annotationId(QualifiedName id,
                                  String node)

addURL

public HashMap<String,String> addURL(QualifiedName id,
                                           HashMap<String,String> properties)

addAnnotationLinkProperties

public HashMap<String,String> addAnnotationLinkProperties(HasOther ann,
                                                                HashMap<String,String> properties)

addActivityShape

public HashMap<String,String> addActivityShape(Activity p,
                                                     HashMap<String,String> properties)

addBlankNodeShape

public HashMap<String,String> addBlankNodeShape(HashMap<String,String> properties)

addActivityLabel

public HashMap<String,String> addActivityLabel(Activity p,
                                                     HashMap<String,String> properties)

addActivityColor

public HashMap<String,String> addActivityColor(Activity p,
                                                     HashMap<String,String> properties)

getStringValue

public String getStringValue(Other o)

addColors

public HashMap<String,String> addColors(HasOther object,
                                              HashMap<String,String> properties)

addEntityShape

public HashMap<String,String> addEntityShape(Entity p,
                                                   HashMap<String,String> properties)

addEntityColor

public HashMap<String,String> addEntityColor(Entity a,
                                                   HashMap<String,String> properties)

addEntityLabel

public HashMap<String,String> addEntityLabel(Entity p,
                                                   HashMap<String,String> properties)

displaySize

public String displaySize(HasOther p)

addAgentShape

public HashMap<String,String> addAgentShape(Agent p,
                                                  HashMap<String,String> properties)

addAgentLabel

public HashMap<String,String> addAgentLabel(Agent p,
                                                  HashMap<String,String> properties)

addAgentColor

public HashMap<String,String> addAgentColor(Agent a,
                                                  HashMap<String,String> properties)

addAnnotationShape

public HashMap<String,String> addAnnotationShape(HasOther ann,
                                                       HashMap<String,String> properties)

addAnnotationLabel

public HashMap<String,String> addAnnotationLabel(HasOther ann,
                                                       HashMap<String,String> properties)

countOthers

public int countOthers(HasOther ann)

convertValue

public String convertValue(Attribute v)

nonEmptyLocalName

public String nonEmptyLocalName(QualifiedName name)

convertProperty

public String convertProperty(Attribute oLabel)

getPropertyFromAny

public String getPropertyFromAny(Attribute o)

getPropertyValueFromAny

public String getPropertyValueFromAny(Type t)

getPropertyValueWithUrl

public String getPropertyValueWithUrl(Attribute t)

getPropertyValueFromAny

public String getPropertyValueFromAny(Attribute o)

addAnnotationColor

public HashMap<String,String> addAnnotationColor(HasOther ann,
                                                       HashMap<String,String> properties)

activityLabel

public String activityLabel(Activity p)

processColor

public String processColor(Activity p)

selectColor

public String selectColor(List<String> colors)

entityLabel

public String entityLabel(Entity p)

entityColor

public String entityColor(Entity p)

agentColor

public String agentColor(Agent p)

annotationColor

public String annotationColor(HasOther ann)

agentLabel

public String agentLabel(Agent p)

convertActivityName

public String convertActivityName(String process)

convertEntityName

public String convertEntityName(String artifact)

convertAgentName

public String convertAgentName(String agent)

emitDependency

public void emitDependency(Relation e,
                           PrintStream out)

addRelationAttributes

public HashMap<String,String> addRelationAttributes(String accountLabel,
                                                          Relation e,
                                                          HashMap<String,String> properties)

addRelationLabel

public void addRelationLabel(Relation e0,
                             HashMap<String,String> properties)

displayRole

public String displayRole(String role)

convertRelationLabel

public String convertRelationLabel(String label)

convertAccount

public String convertAccount(String account)

getRelationStyle

public String getRelationStyle(Relation edge)

getRelationPrintRole

public boolean getRelationPrintRole(Relation edge)

OLDdotify

public String OLDdotify(String name)

dotify

public String dotify(String name)

htmlify

public String htmlify(String name)

emitElement

public void emitElement(QualifiedName name,
                        HashMap<String,String> properties,
                        PrintStream out)

emitBlankNode

public void emitBlankNode(String bnid,
                          HashMap<String,String> properties,
                          PrintStream out)

emitRelation

public void emitRelation(String src,
                         String dest,
                         HashMap<String,String> properties,
                         PrintStream out,
                         boolean directional)

emitProperties

public void emitProperties(StringBuffer sb,
                           HashMap<String,String> properties)

setLayout

public void setLayout(String layout)