ontologizer.io.dot

Class GODOTWriter

java.lang.Object

ontologizer.io.dot.GODOTWriter

public class GODOTWriter
extends Object

Constructor Summary

Constructors

Constructor and Description
GODOTWriter()

Method Summary

Modifier and Type	Method and Description
static TermID	decodeTermID(String encodedTermId) Decode the string that was encoded via encodeTermID(TermID)
static String	encodeTermID(TermID termId) Encode the term id string of the given term id.
static void	writeDOT(Ontology graph, File file, TermID rootTerm, Set<TermID> terms, IDotAttributesProvider provider) Writes out a basic dot file which can be used within graphviz.
static void	writeDOT(Ontology graph, File file, TermID rootTerm, Set<TermID> terms, IDotAttributesProvider provider, String graphAttrs, boolean reverseDirection, boolean edgeLabels, Set<TermID> ignoreTerms) Writes out a basic dot file which can be used within graphviz.

Methods inherited from class java.lang.Object

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

Constructor Detail

GODOTWriter

public GODOTWriter()

Method Detail

encodeTermID

public static String encodeTermID(TermID termId)

Encode the term id string of the given term id.

Parameters:

termId - to be encoded

Returns:

the encoded term id for using it as node's name within the dot file. TODO: Properly escape possibly existing underscore

decodeTermID

public static TermID decodeTermID(String encodedTermId)

Decode the string that was encoded via encodeTermID(TermID)

Parameters:

encodedTermId - the string to be decoded

Returns:

the decoded string

writeDOT

public static void writeDOT(Ontology graph,
                            File file,
                            TermID rootTerm,
                            Set<TermID> terms,
                            IDotAttributesProvider provider)

Writes out a basic dot file which can be used within graphviz. All terms of the terms parameter are included in the graph if they are within the sub graph originating at the rootTerm. In other words, all nodes representing the specified terms up to the given rootTerm node are included.

Parameters:

graph - the ontology

file - defines the file in which the output is written to.

rootTerm - defines the first term of the sub graph which should be considered.

terms - defines which terms should be included within the graphs.

provider - should provide for every property an appropiate id.

writeDOT

public static void writeDOT(Ontology graph,
                            File file,
                            TermID rootTerm,
                            Set<TermID> terms,
                            IDotAttributesProvider provider,
                            String graphAttrs,
                            boolean reverseDirection,
                            boolean edgeLabels,
                            Set<TermID> ignoreTerms)

Writes out a basic dot file which can be used within graphviz. All terms of the terms parameter are included in the graph if they are within the sub graph originating at the rootTerm. In other words, all nodes representing the specified terms up to the given rootTerm node are included.

Parameters:

graph - the ontology

file - defines the file in which the output is written to.

rootTerm - defines the first term of the sub graph which should be considered.

terms - defines which terms should be included within the graphs.

provider - should provide for every property an appropiate id.

reverseDirection - spec

edgeLabels -

ignoreTerms -