de.cau.cs.kieler.klay.layered.properties
Class Properties

java.lang.Object
  extended by de.cau.cs.kieler.klay.layered.properties.Properties

public final class Properties
extends Object

Container for property definitions.

Rating red

Field Summary
static Property<Float> ASPECT_RATIO
          the aspect ratio for packing connected components.
static IProperty<List<LNode>> BARYCENTER_ASSOCIATES
          A list of nodes whose barycenters should go into the barycenter calculation of the node this property is set on.
static Property<Float> BORDER_SPACING
          spacing to the border of the drawing.
static IProperty<List<LNode>> BOTTOM_COMMENTS
          List of comment boxes that are placed in the bottom of of a node.
static IProperty<LinkedList<LNode>> CHILDREN
          List of nodes that are children (direct descendants) of the node that is represented by the property holder.
static IProperty<LPort> COMMENT_CONN_PORT
          The port of a node that originally connected a comment box with that node.
static IProperty<LNode> COMPOUND_NODE
          UPPER_BORDER_DUMMY node determining the compound node this dummy node belongs to.
static IProperty<Integer> CROSSING_HINT
          Crossing hint used for in-layer cross counting with northern and southern port dummies.
static IProperty<CrossingMinimizationStrategy> CROSSMIN
          property to choose a crossing minimization strategy.
static String CROSSMIN_ID
          option identifier for crossing minimization.
static IProperty<CycleBreakingStrategy> CYCLE_BREAKING
          property to choose a cycle breaking strategy.
static String CYCLE_BREAKING_ID
          option identifier for cycle breaking.
static IProperty<Boolean> CYCLIC
          Property of a LayeredGraph.
static float DEF_ASPECT_RATIO
          default value for aspect ratio.
static float DEF_EDGE_SPACING_FACTOR
          default value for edge spacing factor.
static float DEF_SPACING
          default value for object spacing.
static IProperty<Integer> DEPTH
          The depth of a node in the nesting tree of a compound graph.
static IProperty<Boolean> DISTRIBUTE_NODES
          whether nodes shall be distributed during layer assignment.
static String DISTRIBUTE_NODES_ID
          option identifier for distribute nodes.
static IProperty<EdgeConstraint> EDGE_CONSTRAINT
          edge constraints for nodes.
static Property<Float> EDGE_SPACING_FACTOR
          factor for minimal spacing between edges.
static String EDGE_SPACING_FACTOR_ID
          option identifier for edge spacing factor.
static IProperty<EdgeType> EDGE_TYPE
          edge type.
static IProperty<HashMap<KGraphElement,LGraphElement>> ELEMENT_MAP
          Map between KGraph nodes/ports/edges and LGraph nodes/ports/edges.
static IProperty<Double> EXT_PORT_RATIO_OR_POSITION
          The original position or position-to-node-size ratio of an external port.
static IProperty<LNode> EXT_PORT_REPLACED_DUMMY
          External port dummies that represent northern or southern external ports are replaced by new dummy nodes during layout.
static IProperty<PortSide> EXT_PORT_SIDE
          The side of an external port a dummy node was created for.
static IProperty<Set<GraphProperties>> GRAPH_PROPERTIES
          Flags indicating the properties of a graph.
static IProperty<InLayerConstraint> IN_LAYER_CONSTRAINT
          The in-layer constraint placed on a node.
static IProperty<LNode> IN_LAYER_LAYOUT_UNIT
          The layout unit a node belongs to.
static IProperty<LNode> IN_LAYER_SUCCESSOR_CONSTRAINT
          Indicates that a node x may only appear inside a layer before the node y the property is set to.
static IProperty<Boolean> INPUT_COLLECT
          Whether a port is used to collect all incoming edges of a node.
static IProperty<AnchorPoint> INTERACTIVE_LAYOUT_ANCHOR
          property that determines which point in a node determines the result of interactive phases.
static String INTERACTIVE_LAYOUT_ANCHOR_ID
          option identifier for interactive layout anchor point.
static IProperty<KNode> K_PARENT
          KNode that contained the origin of this node in the KGraph.
static IProperty<LayerConstraint> LAYER_CONSTRAINT
          property to set constraints on the node layering.
static String LAYER_CONSTRAINT_ID
          option identifier for layer constraint.
static IProperty<Boolean> LEAVE_DUMMY_PORT
          Flag indicating whether an LPort is set to a leave node in the inclusion tree to enable connections with dummy edges for layering.
static IProperty<LPort> LONG_EDGE_SOURCE
          the source port of a long edge before it was broken into multiple segments.
static IProperty<LPort> LONG_EDGE_TARGET
          the target port of a long edge before it was broken into multiple segments.
static IProperty<Integer> MAX_DEPTH
          The maximum depth of a leave node in the original graph a layered graph is representing.
static IProperty<Boolean> MERGE_PORTS
          Property to enable or disable port merging.
static String MERGE_PORTS_ID
          option identifier for port merging.
static IProperty<Integer> MIN_EDGE_ANGLE
          defines the minimal angle a short edge may have.
static String MIN_EDGE_ANGLE_ID
          option identifier for minimal angle.
static IProperty<LayeringStrategy> NODE_LAYERING
          property to choose a node layering strategy.
static String NODE_LAYERING_ID
          option identifier for node layering.
static IProperty<NodeType> NODE_TYPE
          node type.
static Property<Float> OBJ_SPACING
          minimal spacing between objects.
static IProperty<Object> ORIGIN
          the original object from which a graph element was created.
static IProperty<KVectorChain> ORIGINAL_BENDPOINTS
          the original bend points.
static IProperty<KInsets> ORIGINAL_INSETS
          KInsets of the KNode a upper border dummy node is representing.
static IProperty<Boolean> OUTPUT_COLLECT
          Whether a port is used to collect all outgoing edges of a node.
static IProperty<LGraphElement> PARENT
          LNode that is representative of the node that contains the property holder.
static IProperty<KVector> POSITION_DIFFERENCE
          Difference of Positions for an UPPER_BORDER_DUMMY_NODE before and after the CompoundGraphRestorer.
static Property<Integer> PRIORITY
          priority of elements.
static IProperty<Random> RANDOM
          random number generator for the algorithm.
static IProperty<KVector> RESIZE_RATIO
          width and height ratio by which a node was resized prior to importing.
static IProperty<Boolean> REVERSED
          flag for reversed edges.
static IProperty<LNode> SIDE_OWNER
          LNode that is the left border node for the compound node the side dummy guards the side of.
static IProperty<Integer> THOROUGHNESS
          property that determines how much effort should be spent.
static String THOROUGHNESS_ID
          option identifier for thoroughness.
static IProperty<List<LNode>> TOP_COMMENTS
          List of comment boxes that are placed on top of a node.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ORIGIN

public static final IProperty<Object> ORIGIN
the original object from which a graph element was created.


NODE_TYPE

public static final IProperty<NodeType> NODE_TYPE
node type.


ORIGINAL_BENDPOINTS

public static final IProperty<KVectorChain> ORIGINAL_BENDPOINTS
the original bend points.


EDGE_TYPE

public static final IProperty<EdgeType> EDGE_TYPE
edge type.


REVERSED

public static final IProperty<Boolean> REVERSED
flag for reversed edges.


RANDOM

public static final IProperty<Random> RANDOM
random number generator for the algorithm.


RESIZE_RATIO

public static final IProperty<KVector> RESIZE_RATIO
width and height ratio by which a node was resized prior to importing.


LONG_EDGE_SOURCE

public static final IProperty<LPort> LONG_EDGE_SOURCE
the source port of a long edge before it was broken into multiple segments.


LONG_EDGE_TARGET

public static final IProperty<LPort> LONG_EDGE_TARGET
the target port of a long edge before it was broken into multiple segments.


EDGE_CONSTRAINT

public static final IProperty<EdgeConstraint> EDGE_CONSTRAINT
edge constraints for nodes.


IN_LAYER_LAYOUT_UNIT

public static final IProperty<LNode> IN_LAYER_LAYOUT_UNIT
The layout unit a node belongs to. This property only makes sense for nodes. A layout unit is a set of nodes between which no nodes belonging to other layout units may be placed. Nodes not belonging to any layout unit may be placed arbitrarily between nodes of a layout unit. Layer layout units are identified through one of their nodes.


IN_LAYER_CONSTRAINT

public static final IProperty<InLayerConstraint> IN_LAYER_CONSTRAINT
The in-layer constraint placed on a node. This indicates whether this node should be handled like any other node, or if it must be placed at the top or bottom of a layer. This is important for external port dummy nodes. Crossing minimizers are not required to respect this constraint. If they don't, however, they must include a dependency on InLayerConstraintProcessor.


IN_LAYER_SUCCESSOR_CONSTRAINT

public static final IProperty<LNode> IN_LAYER_SUCCESSOR_CONSTRAINT
Indicates that a node x may only appear inside a layer before the node y the property is set to. That is, having x appear after y would violate this constraint. This property only makes sense for nodes.


CROSSING_HINT

public static final IProperty<Integer> CROSSING_HINT
Crossing hint used for in-layer cross counting with northern and southern port dummies.


GRAPH_PROPERTIES

public static final IProperty<Set<GraphProperties>> GRAPH_PROPERTIES
Flags indicating the properties of a graph.


EXT_PORT_SIDE

public static final IProperty<PortSide> EXT_PORT_SIDE
The side of an external port a dummy node was created for.


EXT_PORT_RATIO_OR_POSITION

public static final IProperty<Double> EXT_PORT_RATIO_OR_POSITION
The original position or position-to-node-size ratio of an external port. This is a property usually used for external port dummy nodes. There is only one coordinate since the side of the port determines the other coordinate. (for eastern and western ports, the x coordinate is determined automatically; for northern and southern ports, the y coordinate is determined automatically)


EXT_PORT_REPLACED_DUMMY

public static final IProperty<LNode> EXT_PORT_REPLACED_DUMMY
External port dummies that represent northern or southern external ports are replaced by new dummy nodes during layout. In these cases, this property is set to the original dummy node.


BARYCENTER_ASSOCIATES

public static final IProperty<List<LNode>> BARYCENTER_ASSOCIATES
A list of nodes whose barycenters should go into the barycenter calculation of the node this property is set on. Nodes in this list are expected to be in the same layer as the node the property is set on. This is primarily used when edges are rerouted from a node to dummy nodes.

This property is currently not declared as one of the layout options offered by KLay Layered and should be considered highly experimental.


K_PARENT

public static final IProperty<KNode> K_PARENT
KNode that contained the origin of this node in the KGraph.


PARENT

public static final IProperty<LGraphElement> PARENT
LNode that is representative of the node that contains the property holder. Property for an LNode.


CHILDREN

public static final IProperty<LinkedList<LNode>> CHILDREN
List of nodes that are children (direct descendants) of the node that is represented by the property holder. Property for an LNode.


SIDE_OWNER

public static final IProperty<LNode> SIDE_OWNER
LNode that is the left border node for the compound node the side dummy guards the side of.


LEAVE_DUMMY_PORT

public static final IProperty<Boolean> LEAVE_DUMMY_PORT
Flag indicating whether an LPort is set to a leave node in the inclusion tree to enable connections with dummy edges for layering.


COMPOUND_NODE

public static final IProperty<LNode> COMPOUND_NODE
UPPER_BORDER_DUMMY node determining the compound node this dummy node belongs to.


ORIGINAL_INSETS

public static final IProperty<KInsets> ORIGINAL_INSETS
KInsets of the KNode a upper border dummy node is representing.


ELEMENT_MAP

public static final IProperty<HashMap<KGraphElement,LGraphElement>> ELEMENT_MAP
Map between KGraph nodes/ports/edges and LGraph nodes/ports/edges.


TOP_COMMENTS

public static final IProperty<List<LNode>> TOP_COMMENTS
List of comment boxes that are placed on top of a node.


BOTTOM_COMMENTS

public static final IProperty<List<LNode>> BOTTOM_COMMENTS
List of comment boxes that are placed in the bottom of of a node.


COMMENT_CONN_PORT

public static final IProperty<LPort> COMMENT_CONN_PORT
The port of a node that originally connected a comment box with that node.


MAX_DEPTH

public static final IProperty<Integer> MAX_DEPTH
The maximum depth of a leave node in the original graph a layered graph is representing.


DEPTH

public static final IProperty<Integer> DEPTH
The depth of a node in the nesting tree of a compound graph.


POSITION_DIFFERENCE

public static final IProperty<KVector> POSITION_DIFFERENCE
Difference of Positions for an UPPER_BORDER_DUMMY_NODE before and after the CompoundGraphRestorer.


INPUT_COLLECT

public static final IProperty<Boolean> INPUT_COLLECT
Whether a port is used to collect all incoming edges of a node.


OUTPUT_COLLECT

public static final IProperty<Boolean> OUTPUT_COLLECT
Whether a port is used to collect all outgoing edges of a node.


CYCLIC

public static final IProperty<Boolean> CYCLIC
Property of a LayeredGraph. Whether the graph has been processed by the cycle breaker and the cycle breaker has detected cycles and reverted edges.


DEF_SPACING

public static final float DEF_SPACING
default value for object spacing.

See Also:
Constant Field Values

OBJ_SPACING

public static final Property<Float> OBJ_SPACING
minimal spacing between objects.


BORDER_SPACING

public static final Property<Float> BORDER_SPACING
spacing to the border of the drawing.


EDGE_SPACING_FACTOR_ID

public static final String EDGE_SPACING_FACTOR_ID
option identifier for edge spacing factor.

See Also:
Constant Field Values

DEF_EDGE_SPACING_FACTOR

public static final float DEF_EDGE_SPACING_FACTOR
default value for edge spacing factor.

See Also:
Constant Field Values

EDGE_SPACING_FACTOR

public static final Property<Float> EDGE_SPACING_FACTOR
factor for minimal spacing between edges.


PRIORITY

public static final Property<Integer> PRIORITY
priority of elements. controls how much single edges are emphasized.


DEF_ASPECT_RATIO

public static final float DEF_ASPECT_RATIO
default value for aspect ratio.

See Also:
Constant Field Values

ASPECT_RATIO

public static final Property<Float> ASPECT_RATIO
the aspect ratio for packing connected components.


MIN_EDGE_ANGLE_ID

public static final String MIN_EDGE_ANGLE_ID
option identifier for minimal angle.

See Also:
Constant Field Values

MIN_EDGE_ANGLE

public static final IProperty<Integer> MIN_EDGE_ANGLE
defines the minimal angle a short edge may have.


DISTRIBUTE_NODES_ID

public static final String DISTRIBUTE_NODES_ID
option identifier for distribute nodes.

See Also:
Constant Field Values

DISTRIBUTE_NODES

public static final IProperty<Boolean> DISTRIBUTE_NODES
whether nodes shall be distributed during layer assignment.


CYCLE_BREAKING_ID

public static final String CYCLE_BREAKING_ID
option identifier for cycle breaking.

See Also:
Constant Field Values

CYCLE_BREAKING

public static final IProperty<CycleBreakingStrategy> CYCLE_BREAKING
property to choose a cycle breaking strategy.


NODE_LAYERING_ID

public static final String NODE_LAYERING_ID
option identifier for node layering.

See Also:
Constant Field Values

NODE_LAYERING

public static final IProperty<LayeringStrategy> NODE_LAYERING
property to choose a node layering strategy.


CROSSMIN_ID

public static final String CROSSMIN_ID
option identifier for crossing minimization.

See Also:
Constant Field Values

CROSSMIN

public static final IProperty<CrossingMinimizationStrategy> CROSSMIN
property to choose a crossing minimization strategy.


THOROUGHNESS_ID

public static final String THOROUGHNESS_ID
option identifier for thoroughness.

See Also:
Constant Field Values

THOROUGHNESS

public static final IProperty<Integer> THOROUGHNESS
property that determines how much effort should be spent.


LAYER_CONSTRAINT_ID

public static final String LAYER_CONSTRAINT_ID
option identifier for layer constraint.

See Also:
Constant Field Values

LAYER_CONSTRAINT

public static final IProperty<LayerConstraint> LAYER_CONSTRAINT
property to set constraints on the node layering.


MERGE_PORTS_ID

public static final String MERGE_PORTS_ID
option identifier for port merging.

See Also:
Constant Field Values

MERGE_PORTS

public static final IProperty<Boolean> MERGE_PORTS
Property to enable or disable port merging. Merging ports is only interesting for edges directly connected to nodes instead of ports. When this option is disabled, one port is created for each edge directly connected to a node. When it is enabled, all such incoming edges share an input port, and all outgoing edges share an output port.


INTERACTIVE_LAYOUT_ANCHOR_ID

public static final String INTERACTIVE_LAYOUT_ANCHOR_ID
option identifier for interactive layout anchor point.

See Also:
Constant Field Values

INTERACTIVE_LAYOUT_ANCHOR

public static final IProperty<AnchorPoint> INTERACTIVE_LAYOUT_ANCHOR
property that determines which point in a node determines the result of interactive phases.