org.corpus_tools.salt.util.internal.persistence.dot.SDocumentGraphDOTWriter Class Reference

Inherits org.corpus_tools.salt.core.GraphTraverseHandler.

Public Member Functions
void	setOutputURI (URI outputURI)
URI	getOutputURI ()
void	setDocumentGraph (SDocumentGraph documentGraph)
SDocumentGraph	getDocumentGraph ()
void	save ()
void	nodeLeft (GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SNode currNode, SRelation< SNode, SNode > relation, SNode fromNode, long order)
	This method will be invoked, when a node is left, after the method checkConstraint(GRAPH_TRAVERSE_TYPE, String, SRelation, SNode, long) has returned true and the method nodeReached(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) has been invoked. More...
boolean	checkConstraint (GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SRelation< SNode, SNode > relation, SNode currNode, long order)
	This method is called during a traversal to check if the current node and eventually its sub-graph shall be traversed or not. More...
void	nodeReached (GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SNode currNode, SRelation relation, SNode fromNode, long order)
Public Member Functions inherited from org.corpus_tools.salt.core.GraphTraverseHandler
void	nodeReached (GRAPH_TRAVERSE_TYPE traversalType, String traversalId, SNode currNode, SRelation< SNode, SNode > relation, SNode fromNode, long order)
	This method will be invoked, when a node is reached, after the method checkConstraint(GRAPH_TRAVERSE_TYPE, String, SRelation, SNode, long) has returned true and before the method nodeLeft(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) is invoked. More...

Static Protected Attributes
static final String	KW_DOT_NS = "dot::"
	Namespace for dot flags.
static final String	KW_DOT_STORED = KW_DOT_NS + "stored"
	String to identify a flag in salt elements or relations, which say that the current element or relation has already been stored or not.

Member Function Documentation

checkConstraint()

boolean org.corpus_tools.salt.util.internal.persistence.dot.SDocumentGraphDOTWriter.checkConstraint	(	GRAPH_TRAVERSE_TYPE	traversalType,
		String	traversalId,
		SRelation< SNode, SNode >	relation,
		SNode	currNode,
		long	order
	)

This method is called during a traversal to check if the current node and eventually its sub-graph shall be traversed or not.

If the return value is false, the traversal for the current path, will stop at the current node and the methods nodeReached(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) and nodeLeft(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) as well will not be invoked. Otherwise the method nodeReached(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) will be invoked, when a new node is reached and nodeLeft(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) will be invoked, when this node is left.

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

Implements org.corpus_tools.salt.core.GraphTraverseHandler.

nodeLeft()

void org.corpus_tools.salt.util.internal.persistence.dot.SDocumentGraphDOTWriter.nodeLeft	(	GRAPH_TRAVERSE_TYPE	traversalType,
		String	traversalId,
		SNode	currNode,
		SRelation< SNode, SNode >	relation,
		SNode	fromNode,
		long	order
	)

This method will be invoked, when a node is left, after the method checkConstraint(GRAPH_TRAVERSE_TYPE, String, SRelation, SNode, long) has returned true and the method nodeReached(GRAPH_TRAVERSE_TYPE, String, SNode, SRelation, SNode, long) has been invoked.

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

Implements org.corpus_tools.salt.core.GraphTraverseHandler.