org.eclipse.gef4.dot

Class DotProperties

java.lang.Object

org.eclipse.gef4.dot.DotProperties

public class DotProperties
extends java.lang.Object

The DotProperties class contains all properties which are supported by the DotImport, i.e. they are set on the resulting Graph.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EDGE_ID Specifies the identifier of an edge.
static java.lang.String	EDGE_LABEL Specifies the label of an edge.
static java.lang.String	EDGE_STYLE Specifies the rendering style of an edge, i.e. if it is solid, dashed, dotted, etc.
static java.lang.String	EDGE_STYLE_DASHDOT This EDGE_STYLE value specifies that the edge is rendered alternately dashed and dotted ("-.").
static java.lang.String	EDGE_STYLE_DASHDOTDOT This EDGE_STYLE value specifies that the edge is rendered alternately dashed and dotted ("-..").
static java.lang.String	EDGE_STYLE_DASHED This EDGE_STYLE value specifies that the edge is rendered dashed.
static java.lang.String	EDGE_STYLE_DEFAULT Defines the default value for the EDGE_STYLE property, which is EDGE_STYLE_SOLID.
static java.lang.String	EDGE_STYLE_DOTTED This EDGE_STYLE value specifies that the edge is rendered dotted.
static java.lang.String	EDGE_STYLE_SOLID This EDGE_STYLE value specifies that the edge is rendered solid.
static java.util.Set<java.lang.String>	EDGE_STYLE_VALUES Defines all possible values for the EDGE_STYLE property.
static java.lang.String	GRAPH_LAYOUT Specifies the layout algorithm which shall be used to layout the graph.
static java.lang.String	GRAPH_LAYOUT_CIRCO This GRAPH_LAYOUT value specifies that the "circo" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_DEFAULT Defines the default value for the GRAPH_LAYOUT property, which is GRAPH_LAYOUT_DOT.
static java.lang.String	GRAPH_LAYOUT_DOT This GRAPH_LAYOUT value specifies that the "dot" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_FDP This GRAPH_LAYOUT value specifies that the "fdp" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_GRID This GRAPH_LAYOUT value specifies that the "grid" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_NEATO This GRAPH_LAYOUT value specifies that the "neato" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_OSAGE This GRAPH_LAYOUT value specifies that the "osage" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_SFDP This GRAPH_LAYOUT value specifies that the "sfdp" layout algorithm is to be used for laying out the graph.
static java.lang.String	GRAPH_LAYOUT_TWOPI This GRAPH_LAYOUT value specifies that the "twopi" layout algorithm is to be used for laying out the graph.
static java.util.Set<java.lang.String>	GRAPH_LAYOUT_VALUES Defines all possible values for the GRAPH_LAYOUT property.
static java.lang.String	GRAPH_RANKDIR Specifies the rankdir property which is passed to the layout algorithm which is used for laying out the graph.
static java.lang.String	GRAPH_RANKDIR_DEFAULT Defines the default value for the GRAPH_RANKDIR property.
static java.lang.String	GRAPH_RANKDIR_LR This GRAPH_RANKDIR value specifies that the graph is to be laid out horizontally from left to right.
static java.lang.String	GRAPH_RANKDIR_TD This GRAPH_RANKDIR value specifies that the graph is to be laid out vertically from top to bottom.
static java.util.Set<java.lang.String>	GRAPH_RANKDIR_VALUES Defines all possible values for the GRAPH_RANKDIR property.
static java.lang.String	GRAPH_TYPE Specifies the graph type.
static java.lang.String	GRAPH_TYPE_DEFAULT Defines the default value for GRAPH_TYPE, which is GRAPH_TYPE_UNDIRECTED.
static java.lang.String	GRAPH_TYPE_DIRECTED This GRAPH_TYPE value specifies that the edges within the graph are directed.
static java.lang.String	GRAPH_TYPE_UNDIRECTED This GRAPH_TYPE value specifies that the edges within the graph are undirected.
static java.util.Set<java.lang.String>	GRAPH_TYPE_VALUES Defines all possible values for the GRAPH_TYPE property.
static java.lang.String	NODE_ID Specifies the identifier of a node.
static java.lang.String	NODE_LABEL Specifies the label of a node.

Constructor Summary

Constructors

Constructor and Description
DotProperties()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getId(org.eclipse.gef4.graph.Edge edge) Returns the value of the EDGE_ID property of the given Edge.
static java.lang.String	getId(org.eclipse.gef4.graph.Node node) Returns the value of the NODE_ID property of the given Node.
static java.lang.String	getLabel(org.eclipse.gef4.graph.Edge edge) Returns the value of the EDGE_LABEL property of the given Edge.
static java.lang.String	getLabel(org.eclipse.gef4.graph.Node node) Returns the value of the NODE_LABEL property of the given Node.
static java.lang.String	getLayout(org.eclipse.gef4.graph.Graph graph) Returns the value of the GRAPH_LAYOUT property of the given Graph.
static java.lang.String	getRankdir(org.eclipse.gef4.graph.Graph graph) Returns the value of the GRAPH_RANKDIR property of the given Graph.
static java.lang.String	getStyle(org.eclipse.gef4.graph.Edge edge) Returns the value of the EDGE_STYLE property of the given Edge.
static java.lang.String	getType(org.eclipse.gef4.graph.Graph graph) Returns the value of the GRAPH_TYPE property of the given Graph.
static void	setId(org.eclipse.gef4.graph.Edge edge, java.lang.String id) Sets the EDGE_ID property of the given Edge to the given id value.
static void	setId(org.eclipse.gef4.graph.Node node, java.lang.String id) Sets the NODE_ID property of the given Node to the given id value.
static void	setLabel(org.eclipse.gef4.graph.Edge edge, java.lang.String label) Sets the EDGE_LABEL property of the given Edge to the given label value.
static void	setLabel(org.eclipse.gef4.graph.Node node, java.lang.String label) Sets the NODE_LABEL property of the given Node to the given label value.
static void	setLayout(org.eclipse.gef4.graph.Graph graph, java.lang.String layout) Sets the GRAPH_LAYOUT property of the given Graph to the given layout value.
static void	setRankdir(org.eclipse.gef4.graph.Graph graph, java.lang.String rankdir) Sets the GRAPH_RANKDIR property of the given Graph to the given rankdir value.
static void	setStyle(org.eclipse.gef4.graph.Edge edge, java.lang.String style) Sets the EDGE_STYLE property of the given Edge to the given style value.
static void	setType(org.eclipse.gef4.graph.Graph graph, java.lang.String type) Sets the GRAPH_TYPE property of the given Graph to the given type value.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_ID

public static final java.lang.String NODE_ID

Specifies the identifier of a node.

See Also:

Constant Field Values

NODE_LABEL

public static final java.lang.String NODE_LABEL

Specifies the label of a node.

See Also:

Constant Field Values

EDGE_ID

public static final java.lang.String EDGE_ID

Specifies the identifier of an edge.

See Also:

Constant Field Values

EDGE_LABEL

public static final java.lang.String EDGE_LABEL

Specifies the label of an edge.

See Also:

Constant Field Values

EDGE_STYLE

public static final java.lang.String EDGE_STYLE

Specifies the rendering style of an edge, i.e. if it is solid, dashed, dotted, etc. Possible values are defined by EDGE_STYLE_VALUES. The default value is defined by EDGE_STYLE_DEFAULT.

See Also:

Constant Field Values

EDGE_STYLE_DASHED

public static final java.lang.String EDGE_STYLE_DASHED

This EDGE_STYLE value specifies that the edge is rendered dashed.

See Also:

Constant Field Values

EDGE_STYLE_DOTTED

public static final java.lang.String EDGE_STYLE_DOTTED

This EDGE_STYLE value specifies that the edge is rendered dotted.

See Also:

Constant Field Values

EDGE_STYLE_SOLID

public static final java.lang.String EDGE_STYLE_SOLID

This EDGE_STYLE value specifies that the edge is rendered solid.

See Also:

Constant Field Values

EDGE_STYLE_DASHDOT

public static final java.lang.String EDGE_STYLE_DASHDOT

This EDGE_STYLE value specifies that the edge is rendered alternately dashed and dotted ("-.").

See Also:

Constant Field Values

EDGE_STYLE_DASHDOTDOT

public static final java.lang.String EDGE_STYLE_DASHDOTDOT

This EDGE_STYLE value specifies that the edge is rendered alternately dashed and dotted ("-..").

See Also:

Constant Field Values

EDGE_STYLE_VALUES

public static final java.util.Set<java.lang.String> EDGE_STYLE_VALUES

Defines all possible values for the EDGE_STYLE property.

EDGE_STYLE_DEFAULT

public static final java.lang.String EDGE_STYLE_DEFAULT

Defines the default value for the EDGE_STYLE property, which is EDGE_STYLE_SOLID.

See Also:

Constant Field Values

GRAPH_TYPE

public static final java.lang.String GRAPH_TYPE

Specifies the graph type. Possible values are defined by GRAPH_TYPE_VALUES. The default value is defined by GRAPH_TYPE_DEFAULT.

See Also:

Constant Field Values

GRAPH_TYPE_DIRECTED

public static final java.lang.String GRAPH_TYPE_DIRECTED

This GRAPH_TYPE value specifies that the edges within the graph are directed.

See Also:

Constant Field Values

GRAPH_TYPE_UNDIRECTED

public static final java.lang.String GRAPH_TYPE_UNDIRECTED

This GRAPH_TYPE value specifies that the edges within the graph are undirected.

See Also:

Constant Field Values

GRAPH_TYPE_VALUES

public static final java.util.Set<java.lang.String> GRAPH_TYPE_VALUES

Defines all possible values for the GRAPH_TYPE property.

GRAPH_TYPE_DEFAULT

public static final java.lang.String GRAPH_TYPE_DEFAULT

Defines the default value for GRAPH_TYPE, which is GRAPH_TYPE_UNDIRECTED.

See Also:

Constant Field Values

GRAPH_LAYOUT

public static final java.lang.String GRAPH_LAYOUT

Specifies the layout algorithm which shall be used to layout the graph. Possible values are defined by GRAPH_LAYOUT_VALUES. The default value is defined by GRAPH_LAYOUT_DEFAULT.

See Also:

Constant Field Values

GRAPH_LAYOUT_DOT

public static final java.lang.String GRAPH_LAYOUT_DOT

This GRAPH_LAYOUT value specifies that the "dot" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_OSAGE

public static final java.lang.String GRAPH_LAYOUT_OSAGE

This GRAPH_LAYOUT value specifies that the "osage" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_GRID

public static final java.lang.String GRAPH_LAYOUT_GRID

This GRAPH_LAYOUT value specifies that the "grid" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_TWOPI

public static final java.lang.String GRAPH_LAYOUT_TWOPI

This GRAPH_LAYOUT value specifies that the "twopi" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_CIRCO

public static final java.lang.String GRAPH_LAYOUT_CIRCO

This GRAPH_LAYOUT value specifies that the "circo" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_NEATO

public static final java.lang.String GRAPH_LAYOUT_NEATO

This GRAPH_LAYOUT value specifies that the "neato" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_FDP

public static final java.lang.String GRAPH_LAYOUT_FDP

This GRAPH_LAYOUT value specifies that the "fdp" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_SFDP

public static final java.lang.String GRAPH_LAYOUT_SFDP

This GRAPH_LAYOUT value specifies that the "sfdp" layout algorithm is to be used for laying out the graph.

See Also:

Constant Field Values

GRAPH_LAYOUT_VALUES

public static final java.util.Set<java.lang.String> GRAPH_LAYOUT_VALUES

Defines all possible values for the GRAPH_LAYOUT property.

GRAPH_LAYOUT_DEFAULT

public static final java.lang.String GRAPH_LAYOUT_DEFAULT

Defines the default value for the GRAPH_LAYOUT property, which is GRAPH_LAYOUT_DOT.

See Also:

Constant Field Values

GRAPH_RANKDIR

public static final java.lang.String GRAPH_RANKDIR

Specifies the rankdir property which is passed to the layout algorithm which is used for laying out the graph. Possible values are defined by GRAPH_RANKDIR_VALUES. The default value is defined by GRAPH_RANKDIR_DEFAULT.

See Also:

Constant Field Values

GRAPH_RANKDIR_LR

public static final java.lang.String GRAPH_RANKDIR_LR

This GRAPH_RANKDIR value specifies that the graph is to be laid out horizontally from left to right.

See Also:

Constant Field Values

GRAPH_RANKDIR_TD

public static final java.lang.String GRAPH_RANKDIR_TD

This GRAPH_RANKDIR value specifies that the graph is to be laid out vertically from top to bottom.

See Also:

Constant Field Values

GRAPH_RANKDIR_VALUES

public static final java.util.Set<java.lang.String> GRAPH_RANKDIR_VALUES

Defines all possible values for the GRAPH_RANKDIR property.

GRAPH_RANKDIR_DEFAULT

public static final java.lang.String GRAPH_RANKDIR_DEFAULT

Defines the default value for the GRAPH_RANKDIR property.

See Also:

Constant Field Values

Constructor Detail

DotProperties

public DotProperties()

Method Detail

getLayout

public static java.lang.String getLayout(org.eclipse.gef4.graph.Graph graph)

Returns the value of the GRAPH_LAYOUT property of the given Graph.

Parameters:

graph - The Graph for which to return the value of the GRAPH_LAYOUT property.

Returns:

The value of the GRAPH_LAYOUT property of the given Graph.

setLayout

public static void setLayout(org.eclipse.gef4.graph.Graph graph,
                             java.lang.String layout)

Sets the GRAPH_LAYOUT property of the given Graph to the given layout value.

Parameters:

graph - The Graph for which to change the value of the GRAPH_LAYOUT property.

layout - The new value for the GRAPH_LAYOUT property.

Throws:

java.lang.IllegalArgumentException - when the given layout value is not supported, i.e. not contained within GRAPH_LAYOUT_VALUES.

getType

public static java.lang.String getType(org.eclipse.gef4.graph.Graph graph)

Returns the value of the GRAPH_TYPE property of the given Graph.

Parameters:

graph - The Graph for which to return the value of the GRAPH_TYPE property.

Returns:

The value of the GRAPH_TYPE property of the given Graph.

setType

public static void setType(org.eclipse.gef4.graph.Graph graph,
                           java.lang.String type)

Sets the GRAPH_TYPE property of the given Graph to the given type value.

Parameters:

graph - The Graph for which to change the value of the GRAPH_TYPE property.

type - The new value for the GRAPH_TYPE property.

Throws:

java.lang.IllegalArgumentException - when the given type value is not supported, i.e. not contained within GRAPH_TYPE_VALUES.

getRankdir

public static java.lang.String getRankdir(org.eclipse.gef4.graph.Graph graph)

Returns the value of the GRAPH_RANKDIR property of the given Graph.

Parameters:

graph - The Graph for which to return the value of the GRAPH_RANKDIR property.

Returns:

The value of the GRAPH_RANKDIR property of the given Graph.

setRankdir

public static void setRankdir(org.eclipse.gef4.graph.Graph graph,
                              java.lang.String rankdir)

Sets the GRAPH_RANKDIR property of the given Graph to the given rankdir value.

Parameters:

graph - The Graph for which to change the value of the GRAPH_RANKDIR property.

rankdir - The new value for the GRAPH_RANKDIR property.

Throws:

java.lang.IllegalArgumentException - when the given rankdir value is not supported, i.e. not contained within GRAPH_RANKDIR_VALUES.

getLabel

public static java.lang.String getLabel(org.eclipse.gef4.graph.Node node)

Returns the value of the NODE_LABEL property of the given Node.

Parameters:

node - The Node for which to return the value of the NODE_LABEL property.

Returns:

The value of the NODE_LABEL property of the given Node.

setLabel

public static void setLabel(org.eclipse.gef4.graph.Node node,
                            java.lang.String label)

Sets the NODE_LABEL property of the given Node to the given label value.

Parameters:

node - The Node for which to change the value of the NODE_LABEL property.

label - The new value for the NODE_LABEL property.

getId

public static java.lang.String getId(org.eclipse.gef4.graph.Node node)

Returns the value of the NODE_ID property of the given Node.

Parameters:

node - The Node for which to return the value of the NODE_ID property.

Returns:

The value of the NODE_ID property of the given Node.

setId

public static void setId(org.eclipse.gef4.graph.Node node,
                         java.lang.String id)

Sets the NODE_ID property of the given Node to the given id value.

Parameters:

node - The Node for which to change the value of the NODE_ID property.

id - The new value for the NODE_ID property.

getLabel

public static java.lang.String getLabel(org.eclipse.gef4.graph.Edge edge)

Returns the value of the EDGE_LABEL property of the given Edge.

Parameters:

edge - The Edge for which to return the value of the EDGE_LABEL property.

Returns:

The value of the EDGE_LABEL property of the given Edge.

setLabel

public static void setLabel(org.eclipse.gef4.graph.Edge edge,
                            java.lang.String label)

Sets the EDGE_LABEL property of the given Edge to the given label value.

Parameters:

edge - The Edge for which to change the value of the EDGE_LABEL property.

label - The new value for the EDGE_LABEL property.

getStyle

public static java.lang.String getStyle(org.eclipse.gef4.graph.Edge edge)

Returns the value of the EDGE_STYLE property of the given Edge.

Parameters:

edge - The Edge for which to return the value of the EDGE_STYLE property.

Returns:

The value of the EDGE_STYLE property of the given Edge.

setStyle

public static void setStyle(org.eclipse.gef4.graph.Edge edge,
                            java.lang.String style)

Sets the EDGE_STYLE property of the given Edge to the given style value.

Parameters:

edge - The Edge for which to change the value of the EDGE_STYLE property.

style - The new value for the EDGE_STYLE property.

Throws:

java.lang.IllegalArgumentException - when the given style value is not supported, i.e. not contained within EDGE_STYLE_VALUES.

getId

public static java.lang.String getId(org.eclipse.gef4.graph.Edge edge)

Returns the value of the EDGE_ID property of the given Edge.

Parameters:

edge - The Edge for which to return the value of the EDGE_ID property.

Returns:

The value of the EDGE_ID property of the given Edge.

setId

public static void setId(org.eclipse.gef4.graph.Edge edge,
                         java.lang.String id)

Sets the EDGE_ID property of the given Edge to the given id value.

Parameters:

edge - The Edge for which to change the value of the EDGE_ID property.

id - The new value for the EDGE_ID property.