org.corpus_tools.salt.util

Class VisJsVisualizer

java.lang.Object

org.corpus_tools.salt.util.VisJsVisualizer

All Implemented Interfaces:

GraphTraverseHandler

public class VisJsVisualizer
extends Object
implements GraphTraverseHandler

This class provides a possibility to create a html file, which visualizes a salt graph, created from an [SDocument](\ref org.corpus_tools.salt.common.SDocument) or from an org.eclipse.emf.common.util.URI of a salt file, using the vis.js library from visjs.org. Also it can be used to get both nodes and relations of a salt document in JSON format. Note, if no export filter used, all nodes and all relations but textual relations will be visualized.

A simple way to use this class for writing the html file is shown in the following example code.

String inputSaltFile = "path_to_your_salt_file"; String outputFolder = "path_to_your_output_folder"; URI uri = URI.createFileURI(inputSaltFile); VisJsVisualizer visJsVisualizer = new VisJsVisualizer(uri); try { URI outputFileUri = URI.createFileURI(outputFolder); visJsVisualizer.visualize(outputFileUri); } catch (IOException | XMLStreamException e) { e.printStackTrace(); }

The next listing shows how to get the nodes and the relations of an input salt file in JSON format by use of this class. For simplicity, the created JSON objects will be written to the standard output. URI uri = URI.createFileURI("path_to_the_input_salt_file"); OutputStream nodeStream = Sytem.out; OutputStream edgeStream = System.out; VisJsVisualizer VisJsVisualizer = new VisJsVisualizer(uri); VisJsVisualizer.setNodeWriter(nodeStream); VisJsVisualizer.setEdgeWriter(edgeStream); VisJsVisualizer.buildJSON(); try { nodeStream.write('\n'); nodeStream.flush(); edgeStream.flush(); } catch (IOException e) { e.printStackTrace(); }

Author:

irina

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSS_FILE
static String	CSS_FOLDER_OUT
BufferedWriter	edgeWriter
static String	HTML_FILE
static String	IMG_FOLDER_OUT
static String	JQUERY_FILE
static String	JS_FILE
static String	JS_FOLDER_OUT
BufferedWriter	nodeWriter

Constructor Summary

Constructors

Constructor and Description
VisJsVisualizer(SDocument doc) Creates a new VisJsVisualizer instance for specified salt document.
VisJsVisualizer(SDocument doc, ExportFilter exportFilter, StyleImporter styleImporter) Creates a new VisJsVisualizer instance with specified export filter for specified salt document.
VisJsVisualizer(org.eclipse.emf.common.util.URI inputFileUri) Creates a new VisJsVisualizer instance for a salt file specified by the uri.
VisJsVisualizer(org.eclipse.emf.common.util.URI inputFileUri, ExportFilter exportFilter, StyleImporter styleImporter) Creates a new VisJsVisualizer instance with specified export filter for a salt file specified by the uri.

Method Summary

Modifier and Type	Method and Description
void	buildJSON() By invoking of this method the graph of the salt document specified by the constructor will be traversed.
boolean	checkConstraint(SGraph.GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SRelation relation, SNode currNode, long order) Implements the checkConstraint method of the GraphTraverseHandler interface.
void	nodeLeft(SGraph.GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SNode currNode, SRelation relation, SNode fromNode, long order) Implements the nodeLeft method of the GraphTraverseHandler interface.
void	nodeReached(SGraph.GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SNode currNode, SRelation relation, SNode fromNode, long order) Implements the nodeReached method of the GraphTraverseHandler interface.
void	setEdgeWriter(OutputStream os) Creates a new buffered writer with specified output stream.
void	setNodeWriter(OutputStream os) Creates a new buffered writer with specified output stream.
void	visualize(org.eclipse.emf.common.util.URI outputFolderUri) This method writes the html document, which visualizes the Salt document, specified by constructor.

Methods inherited from class java.lang.Object

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

Field Detail

nodeWriter

public BufferedWriter nodeWriter

edgeWriter

public BufferedWriter edgeWriter

CSS_FOLDER_OUT

public static final String CSS_FOLDER_OUT

See Also:

Constant Field Values

IMG_FOLDER_OUT

public static final String IMG_FOLDER_OUT

JS_FOLDER_OUT

public static final String JS_FOLDER_OUT

See Also:

Constant Field Values

CSS_FILE

public static final String CSS_FILE

See Also:

Constant Field Values

JS_FILE

public static final String JS_FILE

See Also:

Constant Field Values

JQUERY_FILE

public static final String JQUERY_FILE

See Also:

Constant Field Values

HTML_FILE

public static final String HTML_FILE

See Also:

Constant Field Values

Constructor Detail

VisJsVisualizer

public VisJsVisualizer(SDocument doc)
                throws IOException

Creates a new VisJsVisualizer instance for specified salt document.

Parameters:

doc - an [SDocument](\ref org.corpus_tools.salt.common.SDocument) to be visualized

Throws:

IOException - if creation of tmp file failed *

SaltParameterException - if the doc is null

VisJsVisualizer

public VisJsVisualizer(SDocument doc,
                       ExportFilter exportFilter,
                       StyleImporter styleImporter)
                throws IOException

Creates a new VisJsVisualizer instance with specified export filter for specified salt document.

Parameters:

doc - an [SDocument](\ref org.corpus_tools.salt.common.SDocument) to be visualized

exportFilter - an ExportFilter to include or exclude nodes and/or relations explicitly. If null, all nodes and relations will be visualized.

styleImporter - a StyleImporter to highlight nodes. If null, no nodes will be highlighted.

Throws:

IOException - if creation of tmp file failed

SaltParameterException - if doc is null

VisJsVisualizer

public VisJsVisualizer(org.eclipse.emf.common.util.URI inputFileUri)
                throws IOException

Creates a new VisJsVisualizer instance for a salt file specified by the uri.

Parameters:

inputFileUri - a hierarchical org.eclipse.emf.common.util.URI of a salt file to be visualized. The constructor will create a new [SDocument](\ref org.corpus_tools.salt.common.SDocument) of this.

Throws:

IOException - if creation of tmp file failed

SaltParameterException - - if the inputFileUri is null

VisJsVisualizer

public VisJsVisualizer(org.eclipse.emf.common.util.URI inputFileUri,
                       ExportFilter exportFilter,
                       StyleImporter styleImporter)
                throws IOException

Creates a new VisJsVisualizer instance with specified export filter for a salt file specified by the uri.

Parameters:

inputFileUri - a hierarchical org.eclipse.emf.common.util.URI of a salt file, which has to be visualized. The constructor will create a new [SDocument](\ref org.corpus_tools.salt.common.SDocument) of this.

exportFilter - an ExportFilter to include or exclude nodes and/or relations explicitly. If null, all nodes and relations will be visualized.

styleImporter - a StyleImporter to highlight nodes. If null, no nodes will be highlighted.

Throws:

IOException - if creation of tmp file failed

SaltParameterException - if the inputFileUri is null

SaltResourceException - if a problem occurred while loading salt project from the inputFileUri

Method Detail

visualize

public void visualize(org.eclipse.emf.common.util.URI outputFolderUri)
               throws SaltParameterException,
                      SaltResourceException,
                      SaltException,
                      SaltResourceException,
                      IOException,
                      XMLStreamException

This method writes the html document, which visualizes the Salt document, specified by constructor. The output folder structure will be created, if not yet exists. The output html file as well as the auxiliary files will be written.

The whole output structure will look like following:

Parameters:

outputFolderUri - a hierarchical org.eclipse.emf.common.util.URI that specifies the output folder path. Note, that the output folder have not necessarily to be existing.

Throws:

SaltParameterException - if the outputFolderUri is null

SaltResourceException - if the output auxiliary files cannot have been created

SaltException - if the output folders cannot have been created or permission denied

SaltResourceException - if a problem occurred while copying the auxiliary files

XMLStreamException - if a problem occurred while writing the output html file

IOException - if a problem occurred while writing the output file

setNodeWriter

public void setNodeWriter(OutputStream os)

Creates a new buffered writer with specified output stream. It will contain the nodes in JSON format after invoking of the buildJSON() method.

Parameters:

os - OutputStream associated to the node writer.

setEdgeWriter

public void setEdgeWriter(OutputStream os)

Creates a new buffered writer with specified output stream. It will contain the edges in JSON format after invoking of the buildJSON() method.

Parameters:

os - OutputStream associated to the edge writer

buildJSON

public void buildJSON()
               throws SaltException,
                      SaltParameterException

By invoking of this method the graph of the salt document specified by the constructor will be traversed. Both the nodeWriter and the edgeWriter write nodes and relations of this graph respective to the associated output streams.

Throws:

SaltException - if a problem occurred while building JSON objects

SaltParameterException - if the node writer and/or the edge writer not set

nodeReached

public void nodeReached(SGraph.GRAPH_TRAVERSE_TYPE traversalType,
                        String traversalId,
                        SNode currNode,
                        SRelation relation,
                        SNode fromNode,
                        long order)

Implements the nodeReached method of the GraphTraverseHandler interface.

Specified by:

nodeReached in interface GraphTraverseHandler

Parameters:

traversalType - the type of current traversal

traversalId - the id of current traversal, given by the invoking object

currNode - the current node

relation - the relation via which the current node was reached

fromNode - the parent node

order - the number of the relation in the parent node

nodeLeft

public void nodeLeft(SGraph.GRAPH_TRAVERSE_TYPE traversalType,
                     String traversalId,
                     SNode currNode,
                     SRelation relation,
                     SNode fromNode,
                     long order)

Implements the nodeLeft method of the GraphTraverseHandler interface.

Specified by:

nodeLeft in interface GraphTraverseHandler

Parameters:

traversalType - the type of current traversal

traversalId - the id of current traversal, given by the invoking object

currNode - the current node

relation - the relation via which the current node was reached

fromNode - the parent node

order - the number of the relation in the parent node

checkConstraint

public boolean checkConstraint(SGraph.GRAPH_TRAVERSE_TYPE traversalType,
                               String traversalId,
                               SRelation relation,
                               SNode currNode,
                               long order)

Implements the checkConstraint method of the GraphTraverseHandler interface.

Specified by:

checkConstraint in interface GraphTraverseHandler

Parameters:

traversalType - the type of current traversal

traversalId - the id of current traversal, given by the invoking object

relation - the relation via which the current node was reached

currNode - the current node

order - the number of the relation in the parent node