ilog.views.graphlayout.hierarchical

Class IlvNodeGroup

java.lang.Object

ilog.views.graphlayout.hierarchical.IlvNodeGroup

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvNodeGroup
extends Object
implements IlvPersistentObject

The class IlvNodeGroup allows to create a group of nodes that is subject to a constraint.

A node group itself is not a constraint. But some constraints allow node groups as input rather than single nodes. For instance, it is possible to force a group of nodes to be placed in a higher level than another group of nodes. Or it is possible to force all nodes of the group to be placed no more than a certain number of levels apart.

Since:

JViews 5.0

See Also:

IlvHierarchicalLayout.addConstraint(IlvHierarchicalConstraint), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvNodeGroup() Creates a new IlvNodeGroup.
IlvNodeGroup(IlvInputStream stream) Creates a new IlvNodeGroup from an IlvInputStream.
IlvNodeGroup(IlvNodeGroup source) Creates a new IlvNodeGroup by copying an existing one.
IlvNodeGroup(Vector nodes) Creates a new IlvNodeGroup .

Method Summary

Modifier and Type	Method and Description
void	add(Object node) Adds a node to the node group.
boolean	contains(Object node) Returns true if the node belongs to this group.
Enumeration	elements() Returns the nodes in the node group.
void	remove(Object node) Removes a node from the node group.
int	size() Returns the number of nodes in the node group.
void	write(IlvOutputStream stream) Writes the constraint to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvNodeGroup

public IlvNodeGroup()

Creates a new IlvNodeGroup.

Since:

JViews 5.5

IlvNodeGroup

public IlvNodeGroup(Vector nodes)

Creates a new IlvNodeGroup .

Parameters:

nodes - A vector containing the nodes that belong to this group. The vector is copied into the new group. When a group becomes subject of a constraint, the constraint applies to all nodes of the group.

IlvNodeGroup

public IlvNodeGroup(IlvNodeGroup source)

Creates a new IlvNodeGroup by copying an existing one.

Parameters:

source - The origin of the copy.

IlvNodeGroup

public IlvNodeGroup(IlvInputStream stream)
             throws IOException,
                    IlvReadFileException

Creates a new IlvNodeGroup from an IlvInputStream.

Parameters:

stream - The input stream from which the property must be read.

Throws:

IlvReadFileException - if an error occurs while reading.

IOException

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the constraint to the output stream.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

add

public void add(Object node)

Adds a node to the node group.

Parameters:

node - The node instance.

See Also:

remove(Object)

remove

public void remove(Object node)

Removes a node from the node group.

Parameters:

node - The node instance.

See Also:

add(Object)

size

public int size()

Returns the number of nodes in the node group.

Returns:

The number of nodes in this group.

elements

public Enumeration elements()

Returns the nodes in the node group.

Returns:

The nodes in the node group.

contains

public boolean contains(Object node)

Returns true if the node belongs to this group.

Parameters:

node - The node instance.

Returns:

true if the node belongs to this group.