com.yworks.yfiles.layout.genealogy

Class FamilyTreeLayout

java.lang.Object

com.yworks.yfiles.layout.MultiStageLayout

com.yworks.yfiles.layout.genealogy.FamilyTreeLayout

All Implemented Interfaces:

ILayoutAlgorithm

public class FamilyTreeLayout
extends MultiStageLayout

This layout algorithm arranges genealogical graphs (family trees).

Layout Style

The family trees consist of nodes that represent individuals and nodes that represent families. Individuals are connected via these family nodes. The graph is arranged in layers that describe generations.

Basic Family Tree

Concept

In order to determine whether a node represents an individual or a partnership, a IDataProvider has to be registered with key FAMILY_TYPE_DPKEY. If this IDataProvider is missing, an IllegalArgumentException will be thrown.

This IDataProvider provides:

• FamilyType.MALE for a node representing a male individual.
• FamilyType.FEMALE for a node representing a female individual.
• FamilyType.FAMILY for a node representing a family.

All other values will be interpreted as if the node represents an individual.

A FamilyType.FAMILY node links all members of a family. It can only have two incoming edges from the parents. Two nodes of the same type (families or individuals) cannot be directly connected. If the input graph violates these specifications, a InvalidGraphStructureException exception will be thrown.

The layout is calculated basically in two steps:

• The families are laid out by the inner layouter in a compact way.
• The relations between these "family groups" and their children and other families are laid out by the top layout algorithm.

Features

The distances between nodes in the same generation as well as between individuals and family nodes can be adjusted.

Nodes in the same generation can be aligned at three different coordinates: top, center, bottom.

The location of FamilyType.FAMILY nodes can be specified in relation to the partners. This placement can be set independently for parents.

Field Summary

Fields

Modifier and Type	Field and Description
static NodeDpKey<FamilyType>	FAMILY_TYPE_DPKEY A DataProvider key for assigning a node type for each node The layout algorithm will handle the nodes according to this type.

Constructor Summary

Constructors

Constructor and Description
FamilyTreeLayout() Creates a new instance of FamilyTreeLayout with default settings.

Method Summary

Modifier and Type	Method and Description
void	applyLayoutCore(LayoutGraph graph) Applies a family tree layout to the given graph.
VerticalNodeAlignment	getAlignment() Gets the vertical alignment of the individual nodes in the same generation.
FamilyMembersSortingPolicy	getFamilyMembersSortingPolicy() Gets the order of individuals in the same generation (siblings, partners) based on their sex.
double	getOffsetForFamilyNodes() Gets the offset by which a FamilyType.FAMILY node is shifted down if its parents are not direct neighbors.
double	getSpacingBetweenFamilyMembers() Gets the spacing between two nodes representing members of the same family in one generation.
ILayoutAlgorithm	getTopLayout() Gets the layout algorithm that is responsible for the layout between family groups.
boolean	isPlacingFamilyNodesAlwaysBelowEnabled() Gets whether or not FamilyType.FAMILY nodes are placed between or below the partners.
boolean	isPlacingPartnerlessBelowEnabled() Gets whether or not FamilyType.FAMILY nodes of individuals that have only children but no partners are placed below this individual or next to it.
void	setAlignment(VerticalNodeAlignment value) Sets the vertical alignment of the individual nodes in the same generation.
void	setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy value) Sets the order of individuals in the same generation (siblings, partners) based on their sex.
void	setOffsetForFamilyNodes(double value) Sets the offset by which a FamilyType.FAMILY node is shifted down if its parents are not direct neighbors.
void	setParallelEdgeRouterEnabled(boolean value) Sets whether or not the ILayoutStage used for routing parallel edges is activated.
void	setPlacingFamilyNodesAlwaysBelowEnabled(boolean value) Sets whether or not FamilyType.FAMILY nodes are placed between or below the partners.
void	setPlacingPartnerlessBelowEnabled(boolean value) Sets whether or not FamilyType.FAMILY nodes of individuals that have only children but no partners are placed below this individual or next to it.
void	setSelfLoopRouterEnabled(boolean value) Sets whether or not the ILayoutStage used for routing self-loops is activated.
void	setSpacingBetweenFamilyMembers(double value) Sets the spacing between two nodes representing members of the same family in one generation.
void	setTopLayout(ILayoutAlgorithm value) Sets the layout algorithm that is responsible for the layout between family groups.

Methods inherited from class com.yworks.yfiles.layout.MultiStageLayout

appendStage, applyLayout, checkNodeSize, disableAllStages, getComponentLayout, getHideGroupsStage, getLabeling, getLayoutOrientation, getOrientationLayout, getParallelEdgeRouter, getSelfLoopRouter, getSubgraphLayout, isComponentLayoutEnabled, isHideGroupsStageEnabled, isLabelingEnabled, isOrientationLayoutEnabled, isParallelEdgeRouterEnabled, isSelfLoopRouterEnabled, isSubgraphLayoutEnabled, prependStage, removeStage, setComponentLayout, setComponentLayoutEnabled, setHideGroupsStage, setHideGroupsStageEnabled, setLabeling, setLabelingEnabled, setLayoutOrientation, setOrientationLayout, setOrientationLayoutEnabled, setParallelEdgeRouter, setSelfLoopRouter, setSubgraphLayout, setSubgraphLayoutEnabled

Methods inherited from class java.lang.Object

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

Field Detail

FAMILY_TYPE_DPKEY

public static final NodeDpKey<FamilyType> FAMILY_TYPE_DPKEY

A DataProvider key for assigning a node type for each node

The layout algorithm will handle the nodes according to this type.

Constructor Detail

FamilyTreeLayout

public FamilyTreeLayout()

Creates a new instance of FamilyTreeLayout with default settings.

Method Detail

applyLayoutCore

public void applyLayoutCore(LayoutGraph graph)

Applies a family tree layout to the given graph.

Specified by:

applyLayoutCore in class MultiStageLayout

Throws:

IllegalStateException - if no IDataProvider is registered using FAMILY_TYPE_DPKEY

InvalidGraphStructureException - if a FamilyType.FAMILY node has more than two parents or two nodes of the same type are linked together

Parameters:

graph - the input graph

getAlignment

public VerticalNodeAlignment getAlignment()

Gets the vertical alignment of the individual nodes in the same generation.

Throws:

IllegalArgumentException - if the specified alignment is unknown

Default Value:

The default value is VerticalNodeAlignment.CENTER

Returns:

one of the valid alignment specifiers

See Also:

setAlignment(VerticalNodeAlignment)

getFamilyMembersSortingPolicy

public FamilyMembersSortingPolicy getFamilyMembersSortingPolicy()

Gets the order of individuals in the same generation (siblings, partners) based on their sex.

Throws:

IllegalArgumentException - if the specified order is unknown

Default Value:

The default value is FamilyMembersSortingPolicy.NO_SORTING

Returns:

one of the valid order specifiers

See Also:

setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

getOffsetForFamilyNodes

public double getOffsetForFamilyNodes()

Gets the offset by which a FamilyType.FAMILY node is shifted down if its parents are not direct neighbors.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given offset is negative

Default Value:

The default value is 10.

Returns:

the offset for FamilyType.FAMILY nodes to their parents

See Also:

setOffsetForFamilyNodes(double)

getSpacingBetweenFamilyMembers

public double getSpacingBetweenFamilyMembers()

Gets the spacing between two nodes representing members of the same family in one generation.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given spacing is negative

Default Value:

The default value is 30.

Returns:

the spacing between family members

See Also:

setSpacingBetweenFamilyMembers(double)

getTopLayout

public ILayoutAlgorithm getTopLayout()

Gets the layout algorithm that is responsible for the layout between family groups.

If the specified layout algorithm is null, fallback algorithm HierarchicLayout is used.

Default Value:

The default value is HierarchicLayout

Returns:

the layout algorithm

See Also:

setTopLayout(ILayoutAlgorithm)

isPlacingFamilyNodesAlwaysBelowEnabled

public boolean isPlacingFamilyNodesAlwaysBelowEnabled()

Gets whether or not FamilyType.FAMILY nodes are placed between or below the partners.

Default Value:

The default value is false. FamilyType.FAMILY nodes are placed between the partners.

Returns:

true if FamilyType.FAMILY nodes are placed below the partners, false otherwise

See Also:

FamilyType.FAMILY, setPlacingFamilyNodesAlwaysBelowEnabled(boolean)

isPlacingPartnerlessBelowEnabled

public boolean isPlacingPartnerlessBelowEnabled()

Gets whether or not FamilyType.FAMILY nodes of individuals that have only children but no partners are placed below this individual or next to it.

When enabled, direct inheritance lines are straightened.

Default Value:

The default value is true. FamilyType.FAMILY nodes are placed below single parents.

Returns:

true if FamilyType.FAMILY nodes with only one parent will be placed below this individual, false otherwise

See Also:

setPlacingPartnerlessBelowEnabled(boolean)

setAlignment

public void setAlignment(VerticalNodeAlignment value)

Sets the vertical alignment of the individual nodes in the same generation.

Throws:

IllegalArgumentException - if the specified alignment is unknown

Default Value:

The default value is VerticalNodeAlignment.CENTER

Parameters:

value - one of the valid alignment specifiers

See Also:

getAlignment()

setFamilyMembersSortingPolicy

public void setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy value)

Sets the order of individuals in the same generation (siblings, partners) based on their sex.

Throws:

IllegalArgumentException - if the specified order is unknown

Default Value:

The default value is FamilyMembersSortingPolicy.NO_SORTING

Parameters:

value - one of the valid order specifiers

See Also:

getFamilyMembersSortingPolicy()

setOffsetForFamilyNodes

public void setOffsetForFamilyNodes(double value)

Sets the offset by which a FamilyType.FAMILY node is shifted down if its parents are not direct neighbors.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given offset is negative

Default Value:

The default value is 10.

Parameters:

value - the offset for FamilyType.FAMILY nodes to their parents

See Also:

getOffsetForFamilyNodes()

setParallelEdgeRouterEnabled

public void setParallelEdgeRouterEnabled(boolean value)

Sets whether or not the ILayoutStage used for routing parallel edges is activated.

Overrides:

setParallelEdgeRouterEnabled in class MultiStageLayout

FamilyTreeLayout cannot handle parallel edges. Disabling ParallelEdgeRouter will lead to errors during execution.

Default Value:

The default value is true. The stage that routes parallel edges is activated.

Parameters:

value - true if the stage responsible for routing parallel edges is activated, false otherwise

See Also:

MultiStageLayout.isParallelEdgeRouterEnabled(), MultiStageLayout.setParallelEdgeRouter(ILayoutStage), ParallelEdgeRouter

setPlacingFamilyNodesAlwaysBelowEnabled

public void setPlacingFamilyNodesAlwaysBelowEnabled(boolean value)

Sets whether or not FamilyType.FAMILY nodes are placed between or below the partners.

Default Value:

The default value is false. FamilyType.FAMILY nodes are placed between the partners.

Parameters:

value - true if FamilyType.FAMILY nodes are placed below the partners, false otherwise

See Also:

FamilyType.FAMILY, isPlacingFamilyNodesAlwaysBelowEnabled()

setPlacingPartnerlessBelowEnabled

public void setPlacingPartnerlessBelowEnabled(boolean value)

Sets whether or not FamilyType.FAMILY nodes of individuals that have only children but no partners are placed below this individual or next to it.

When enabled, direct inheritance lines are straightened.

Default Value:

The default value is true. FamilyType.FAMILY nodes are placed below single parents.

Parameters:

value - true if FamilyType.FAMILY nodes with only one parent will be placed below this individual, false otherwise

See Also:

isPlacingPartnerlessBelowEnabled()

setSelfLoopRouterEnabled

public void setSelfLoopRouterEnabled(boolean value)

Sets whether or not the ILayoutStage used for routing self-loops is activated.

Overrides:

setSelfLoopRouterEnabled in class MultiStageLayout

FamilyTreeLayout cannot handle self-loops. Disabling SelfLoopRouter will lead to errors during execution.

Default Value:

The default value is true. The stage that routes self-loops is activated.

Parameters:

value - true if the stage responsible for routing self-loops is activated, false otherwise

See Also:

MultiStageLayout.isSelfLoopRouterEnabled(), MultiStageLayout.setSelfLoopRouter(ILayoutStage), SelfLoopRouter

setSpacingBetweenFamilyMembers

public void setSpacingBetweenFamilyMembers(double value)

Sets the spacing between two nodes representing members of the same family in one generation.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given spacing is negative

Default Value:

The default value is 30.

Parameters:

value - the spacing between family members

See Also:

getSpacingBetweenFamilyMembers()

setTopLayout

public void setTopLayout(ILayoutAlgorithm value)

Sets the layout algorithm that is responsible for the layout between family groups.

If the specified layout algorithm is null, fallback algorithm HierarchicLayout is used.

Default Value:

The default value is HierarchicLayout

Parameters:

value - the layout algorithm

See Also:

getTopLayout()