io.gitlab.nats.deptreeviz

Class DepTree<T extends ParseInterface<E>,E extends WordInterface>

java.lang.Object

io.gitlab.nats.deptreeviz.DepTree<T,E>

All Implemented Interfaces:

java.lang.Iterable<DepTreeNode>

public class DepTree<T extends ParseInterface<E>,E extends WordInterface>
extends java.lang.Object
implements java.lang.Iterable<DepTreeNode>

Contains the graphical information of the tree that results from a parse, plus any listeners that are attached to the elements of the SVGDocument

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DepTree.Elem

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	invisible
static java.awt.Color	transWhite

Constructor Summary

Constructors

Constructor and Description
DepTree()
DepTree(java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes, int windowSizeX, int windowSizeY, int lineThickness, java.awt.Color highlightColor, java.awt.Color selectColor, java.awt.Font font)
DepTree(T parse) Generates a DepTree from a Parse for extracting the canvas or the DOM tree from it
DepTree(T parse, java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes) Generates a DepTree from a Parse for extracting the canvas or the DOM tree from it

Method Summary

Modifier and Type	Method and Description
void	addToTransparentBoxes(java.awt.Shape shape)
void	changeColor(java.util.ArrayList<org.w3c.dom.Element> nodeElements, java.awt.Color color) Changes the color of the elements of a coloring group
void	draw(T parse)
java.awt.Dimension	getCanvasSize()
int	getCanvasSizeY()
java.lang.String	getCurrentLevel()
double	getCurrentYLength()
T	getDecParse()
org.w3c.dom.svg.SVGDocument	getDoc()
java.util.ArrayList<org.w3c.dom.Element>	getElements(DepTreeBaseInteractor.Com type, DepTreeNode node, java.lang.String level, boolean isTarget)
java.awt.Font	getFont()
java.awt.Color	getHighlightColor()
java.util.ArrayList<java.lang.String>	getLevels()
int	getLineThickness()
java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>>	getMarkedNodes()
double	getMinY()
java.awt.Color	getMouseoverColor()
DepTreeNode	getNode(int i)
org.apache.batik.swing.JSVGCanvas	getNodesCanvas()
java.util.ArrayList<java.lang.Double>	getNonCurrentYs()
double	getREFYLength()
java.awt.Color	getSelectColor()
java.awt.Color	getTransparentColor()
java.awt.Dimension	getWindowSize()
double	getZoomFactor()
void	highlight(DepTreeNode node) Colors highlighted links of nodes or resets their color to black or red for backwards links if they stop being highlighted.
void	highlightNodes()
boolean	isBusy()
boolean	isDrawingRoots()
boolean	isDroppingLeaves()
boolean	isParsingIncrementally()
boolean	isShowingCat()
boolean	isShowingReferent()
java.util.Iterator<DepTreeNode>	iterator()
void	redraw()
void	refreshDisplay()
void	resetMarkedNodes()
void	resetTransparentBoxes(java.awt.geom.Area visibleArea)
void	setBoxType(io.gitlab.nats.deptreeviz.DepTree.BoxType boxType)
void	setBusy(boolean busy)
void	setCurrentLevel(java.lang.String currentLevel)
void	setCurrentYLength(double currentYLength)
void	setDecParse(T decParse)
void	setDrawingBoxes(boolean drawingBoxes)
void	setDrawingRoots(boolean drawRoot)
void	setDroppingLeaves(boolean droppingLeaves)
void	setFont(java.awt.Font font)
void	setHighlightColor(java.awt.Color highlightColor)
void	setLevels(java.util.ArrayList<java.lang.String> levels)
void	setLineThickness(int lineThickness)
void	setMarkedNodes(java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes)
void	setMinX(int minX)
void	setMinY(double minY)
void	setMouseoverColor(java.awt.Color mouseoverColor)
void	setParsingIncrementally(boolean parsingIncrementally)
void	setREFYLength(double refYLength)
void	setSelectColor(java.awt.Color selectColor)
void	setSelectThickness(int selectThickness)
void	setShowingCat(boolean showingCat)
void	setShowingReferent(boolean showingReferent)
void	setTransparentColor(java.awt.Color transparentColor)
void	setVerticesLabels(java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels)
void	setVerticesStructure(java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure)
void	setWindowSize(java.awt.Dimension windowSize)
void	setZoomFactor(double zoomFactor)
static void	writeTree(java.util.List<java.lang.String> levels, java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels, java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure, java.util.List<java.lang.String> words, java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes, java.io.Writer w) Generates the XML data of a tree from the relevant parts of a parse and writes it into a file.
static void	writeTree(java.util.List<java.lang.String> levels, java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels, java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure, java.util.List<java.lang.String> words, java.io.Writer w) Generates the XML data of a tree from the relevant parts of a parse and writes it into a file.
void	writeTree(java.io.Writer writer) Writes SVG to given writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

transWhite

public static java.awt.Color transWhite

invisible

public static java.awt.Color invisible

Constructor Detail

DepTree

public DepTree()

DepTree

public DepTree(java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes,
               int windowSizeX,
               int windowSizeY,
               int lineThickness,
               java.awt.Color highlightColor,
               java.awt.Color selectColor,
               java.awt.Font font)

DepTree

public DepTree(T parse)

Generates a DepTree from a Parse for extracting the canvas or the DOM tree from it

DepTree

public DepTree(T parse,
               java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes)

Generates a DepTree from a Parse for extracting the canvas or the DOM tree from it

Method Detail

iterator

public java.util.Iterator<DepTreeNode> iterator()

Specified by:

iterator in interface java.lang.Iterable<DepTreeNode>

getNode

public DepTreeNode getNode(int i)

getElements

public java.util.ArrayList<org.w3c.dom.Element> getElements(DepTreeBaseInteractor.Com type,
                                                            DepTreeNode node,
                                                            java.lang.String level,
                                                            boolean isTarget)

refreshDisplay

public void refreshDisplay()

setLevels

public void setLevels(java.util.ArrayList<java.lang.String> levels)

getLevels

public java.util.ArrayList<java.lang.String> getLevels()

setVerticesLabels

public void setVerticesLabels(java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels)

setVerticesStructure

public void setVerticesStructure(java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure)

getDoc

public org.w3c.dom.svg.SVGDocument getDoc()

setSelectThickness

public void setSelectThickness(int selectThickness)

setMouseoverColor

public void setMouseoverColor(java.awt.Color mouseoverColor)

getMouseoverColor

public java.awt.Color getMouseoverColor()

setLineThickness

public void setLineThickness(int lineThickness)

getLineThickness

public int getLineThickness()

getCanvasSizeY

public int getCanvasSizeY()

setWindowSize

public void setWindowSize(java.awt.Dimension windowSize)

getWindowSize

public java.awt.Dimension getWindowSize()

getCanvasSize

public java.awt.Dimension getCanvasSize()

setHighlightColor

public void setHighlightColor(java.awt.Color highlightColor)

getHighlightColor

public java.awt.Color getHighlightColor()

setSelectColor

public void setSelectColor(java.awt.Color selectColor)

getSelectColor

public java.awt.Color getSelectColor()

setFont

public void setFont(java.awt.Font font)

getFont

public java.awt.Font getFont()

setCurrentYLength

public void setCurrentYLength(double currentYLength)

getCurrentYLength

public double getCurrentYLength()

setREFYLength

public void setREFYLength(double refYLength)

getREFYLength

public double getREFYLength()

setMinX

public void setMinX(int minX)

setMinY

public void setMinY(double minY)

getMinY

public double getMinY()

setMarkedNodes

public void setMarkedNodes(java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes)

resetMarkedNodes

public void resetMarkedNodes()

getMarkedNodes

public java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> getMarkedNodes()

getNodesCanvas

public org.apache.batik.swing.JSVGCanvas getNodesCanvas()

setCurrentLevel

public void setCurrentLevel(java.lang.String currentLevel)

getCurrentLevel

public java.lang.String getCurrentLevel()

getNonCurrentYs

public java.util.ArrayList<java.lang.Double> getNonCurrentYs()

isDroppingLeaves

public boolean isDroppingLeaves()

setDroppingLeaves

public void setDroppingLeaves(boolean droppingLeaves)

isShowingCat

public boolean isShowingCat()

setShowingCat

public void setShowingCat(boolean showingCat)

getDecParse

public T getDecParse()

setDecParse

public void setDecParse(T decParse)

getZoomFactor

public double getZoomFactor()

setZoomFactor

public void setZoomFactor(double zoomFactor)

isDrawingRoots

public boolean isDrawingRoots()

setDrawingRoots

public void setDrawingRoots(boolean drawRoot)

getTransparentColor

public java.awt.Color getTransparentColor()

setTransparentColor

public void setTransparentColor(java.awt.Color transparentColor)

isParsingIncrementally

public boolean isParsingIncrementally()

setParsingIncrementally

public void setParsingIncrementally(boolean parsingIncrementally)

resetTransparentBoxes

public void resetTransparentBoxes(java.awt.geom.Area visibleArea)

addToTransparentBoxes

public void addToTransparentBoxes(java.awt.Shape shape)

setDrawingBoxes

public void setDrawingBoxes(boolean drawingBoxes)

setBoxType

public void setBoxType(io.gitlab.nats.deptreeviz.DepTree.BoxType boxType)

isBusy

public boolean isBusy()

setBusy

public void setBusy(boolean busy)

isShowingReferent

public boolean isShowingReferent()

setShowingReferent

public void setShowingReferent(boolean showingReferent)

draw

public void draw(T parse)

redraw

public void redraw()

highlightNodes

public void highlightNodes()

highlight

public void highlight(DepTreeNode node)

Colors highlighted links of nodes or resets their color to black or red for backwards links if they stop being highlighted. This requires the DOM elements of the corresponding graphic objects to be stored in the right coloring groups.

Parameters:

node - the node worked on

changeColor

public void changeColor(java.util.ArrayList<org.w3c.dom.Element> nodeElements,
                        java.awt.Color color)

Changes the color of the elements of a coloring group

Parameters:

nodeElements - a list of the DOM elements describing the graphic objects of a coloring group

writeTree

public void writeTree(java.io.Writer writer)
               throws org.apache.batik.svggen.SVGGraphics2DIOException

Writes SVG to given writer. This is probably the method you want if you need an SVG.

Parameters:

writer - receives the SVG. Use StringWriter if you want to get a String.

Throws:

org.apache.batik.svggen.SVGGraphics2DIOException - If for some reason writing failed

writeTree

public static void writeTree(java.util.List<java.lang.String> levels,
                             java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels,
                             java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure,
                             java.util.List<java.lang.String> words,
                             java.io.Writer w)

Generates the XML data of a tree from the relevant parts of a parse and writes it into a file.

writeTree

public static void writeTree(java.util.List<java.lang.String> levels,
                             java.util.Map<java.lang.String,java.util.List<java.lang.String>> verticesLabels,
                             java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> verticesStructure,
                             java.util.List<java.lang.String> words,
                             java.util.Map<java.lang.Integer,java.util.ArrayList<java.lang.String>> markedNodes,
                             java.io.Writer w)

Generates the XML data of a tree from the relevant parts of a parse and writes it into a file.