ilog.views.graphlayout.hierarchical

Class IlvHierarchicalConstraint

java.lang.Object

ilog.views.graphlayout.hierarchical.IlvHierarchicalConstraint

All Implemented Interfaces:

IlvPersistentObject

Direct Known Subclasses:

IlvExtremityConstraint, IlvGroupSpreadConstraint, IlvLevelRangeConstraint, IlvRelativeConstraint, IlvSameLevelConstraint, IlvSideBySideConstraint, IlvSwimLaneConstraint

public abstract class IlvHierarchicalConstraint
extends Object
implements IlvPersistentObject

The abstract class IlvHierarchicalConstraint is the base class for constraints of the Hierarchical Layout. Constraints can be used to influence the way the layout algorithms partition the nodes into levels and order the nodes within the levels.

Since:

JViews 5.0

See Also:

IlvHierarchicalLayout.addConstraint(IlvHierarchicalConstraint)

Constructor Summary

Constructors

Constructor and Description
IlvHierarchicalConstraint(float priority) Creates a new IlvHierarchicalConstraint.
IlvHierarchicalConstraint(IlvHierarchicalConstraint source) Creates a new IlvHierarchicalConstraint by copying an existing one.
IlvHierarchicalConstraint(IlvInputStream stream) Creates a new IlvHierarchicalConstraint from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
abstract IlvHierarchicalConstraint	copy() Copies the constraint.
float	getPriority() Returns the priority of the constraint.
void	setPriority(float priority) Sets the priority of the constraint.
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

IlvHierarchicalConstraint

public IlvHierarchicalConstraint(float priority)

Creates a new IlvHierarchicalConstraint.

Parameters:

priority - The priority of the constraint. If there are conflicts between constraints, the constraint with the highest priority wins.

IlvHierarchicalConstraint

public IlvHierarchicalConstraint(IlvHierarchicalConstraint source)

Creates a new IlvHierarchicalConstraint by copying an existing one.

Parameters:

source - The origin of the copy.

IlvHierarchicalConstraint

public IlvHierarchicalConstraint(IlvInputStream stream)
                          throws IOException,
                                 IlvReadFileException

Creates a new IlvHierarchicalConstraint 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

copy

public abstract IlvHierarchicalConstraint copy()

Copies the constraint.

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.

getPriority

public final float getPriority()

Returns the priority of the constraint.

If there are conflicts between constraints, the constraint with the highest priority wins.

See Also:

setPriority(float)

setPriority

public final void setPriority(float priority)

Sets the priority of the constraint. If there are conflicts between constraints, the constraint with the highest priority wins.

See Also:

getPriority()