IlvGraphLayoutReport (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.graphlayout.IlvGraphLayoutReport

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvLongLinkLayoutReport, IlvMultipleLayoutReport, IlvRecursiveLayoutReport, IlvTopologicalMeshLayoutReport, IlvUniformLengthEdgesLayoutReport
```
public class IlvGraphLayoutReport
extends Object
implements Serializable
```
The base class of the objects used to store information about the behavior of the layout algorithms.
The layout report is returned by the method IlvGraphLayout.performLayout(). It can be also obtained during the layout using the layout event listener mechanism.

Since:

JViews 2.0

See Also:

IlvGraphLayout, IlvGraphLayout.performLayout(), IlvGraphLayout.addGraphLayoutEventListener(ilog.views.graphlayout.GraphLayoutEventListener), GraphLayoutEvent, GraphLayoutEventListener, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMPTY_GRAPHER` The layout was not performed because the graph is empty.
`static int`	`EXCEPTION_DURING_LAYOUT` An exception has been raised during layout.
`static int`	`GREATEST_CODE` The largest integer value used as an error code.
`static int`	`INITIAL_CODE` The initial value of the code.
`static int`	`LAYOUT_DONE` The layout was performed normally.
`static int`	`LAYOUT_FINISHED` The layout was finished.
`static int`	`LAYOUT_STARTED` The layout was started.
`static int`	`NO_MOVEABLE_NODE` Deprecated. Beginning with JViews 3.5, this code is no longer used. In all cases when this code was set, the code `LAYOUT_DONE` is set instead.
`static int`	`NO_RESHAPEABLE_LINK` Deprecated. Beginning with JViews 3.5, this code is no longer used. In all cases when this code was set, the code `LAYOUT_DONE` is set instead.
`static int`	`NOT_NEEDED` The layout was not performed because there was no significant change in the graph since the last time the layout was performed successfully.
`static int`	`STOPPED_AND_INVALID` The layout was performed but stopped because either the layout time elapsed or `IlvGraphLayout.stopImmediately()` was called, and the result cannot be considered a valid layout.
`static int`	`STOPPED_AND_VALID` The layout was performed but stopped because either the layout time elapsed or `IlvGraphLayout.stopImmediately()` was called, and the result can be considered a valid layout.

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlvGraphLayoutReport()
Creates a new instance of the report object.

Constructors
Modifier	Constructor and Description
`protected`	`IlvGraphLayoutReport()` Creates a new instance of the report object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`codeToString(int code)` Returns a message string (in English) corresponding to the code value that can be obtained by `getCode()`.
`String`	`codeToString(int code, ULocale locale)` Returns a message string corresponding to the code value that can be obtained by `getCode()`.
`int`	`getCode()` Returns the code describing the current state of the layout algorithm.
`long`	`getLayoutTime()` Returns the total duration of the layout algorithm (in milliseconds).
`int`	`getPercentageComplete()` Returns the current percentage of completion during layout, if the layout algorithm supports the percentage completion feature.
`void`	`setCode(int code)` Sets the code for the current state of the layout algorithm.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INITIAL_CODE
```
public static final int INITIAL_CODE
```
    The initial value of the code. The method getCode() returns this value if no different code was ever set.
    
    See Also:
    
    getCode(), Constant Field Values
  - EMPTY_GRAPHER
```
public static final int EMPTY_GRAPHER
```
    The layout was not performed because the graph is empty.
    
    See Also:
    
    getCode(), Constant Field Values
  - NO_MOVEABLE_NODE
```
public static final int NO_MOVEABLE_NODE
```
    Deprecated. Beginning with JViews 3.5, this code is no longer used. In all cases when this code was set, the code LAYOUT_DONE is set instead.
    
    The layout was not performed because there are no movable nodes (all nodes are fixed). This may occur only if the subclass of IlvGraphLayout supports the preservation of fixed nodes (see IlvGraphLayout.supportsPreserveFixedNodes()) and the method IlvGraphLayout.setPreserveFixedNodes(boolean) has been called with a true argument.
    
    See Also:
    
    getCode(), Constant Field Values
  - NO_RESHAPEABLE_LINK
```
public static final int NO_RESHAPEABLE_LINK
```
    Deprecated. Beginning with JViews 3.5, this code is no longer used. In all cases when this code was set, the code LAYOUT_DONE is set instead.
    
    The layout was not performed because there are no reshapeable links (all links are fixed). This may occur only if the subclass of IlvGraphLayout supports the preservation of fixed links (see IlvGraphLayout.supportsPreserveFixedLinks()) and the method IlvGraphLayout.setPreserveFixedLinks(boolean) has been called with a true argument.
    
    See Also:
    
    getCode(), Constant Field Values
  - NOT_NEEDED
```
public static final int NOT_NEEDED
```
    The layout was not performed because there was no significant change in the graph since the last time the layout was performed successfully. This usually means that there was no change in the topology (no nodes or links were added or removed), no change in position (no nodes or links were moved), and no change in parameter values.
    
    See Also:
    
    getCode(), Constant Field Values
  - LAYOUT_DONE
```
public static final int LAYOUT_DONE
```
    The layout was performed normally.
    
    See Also:
    
    getCode(), Constant Field Values
  - STOPPED_AND_VALID
```
public static final int STOPPED_AND_VALID
```
    The layout was performed but stopped because either the layout time elapsed or IlvGraphLayout.stopImmediately() was called, and the result can be considered a valid layout. Iterative layout algorithms that can be stopped at any iteration set this result code if they do not run to completion (see IlvGraphLayout.supportsStopImmediately() and IlvGraphLayout.supportsAllowedTime()).
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    getCode(), Constant Field Values
  - STOPPED_AND_INVALID
```
public static final int STOPPED_AND_INVALID
```
    The layout was performed but stopped because either the layout time elapsed or IlvGraphLayout.stopImmediately() was called, and the result cannot be considered a valid layout. Noniterative layout algorithms set this result code if they do not run to completion (see IlvGraphLayout.supportsStopImmediately() and IlvGraphLayout.supportsAllowedTime()). The nodes and links are either at intermediate positions (that is, the positions seem to be placed randomly) or have not changed at all, depending on the specific behavior of the layout algorithm.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    getCode(), Constant Field Values
  - LAYOUT_STARTED
```
public static final int LAYOUT_STARTED
```
    The layout was started.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    getCode(), GraphLayoutEvent.isLayoutStarted(), Constant Field Values
  - LAYOUT_FINISHED
```
public static final int LAYOUT_FINISHED
```
    The layout was finished.
    
    Since:
    
    JViews 3.0
    
    See Also:
    
    getCode(), GraphLayoutEvent.isLayoutFinished(), Constant Field Values
  - EXCEPTION_DURING_LAYOUT
```
public static final int EXCEPTION_DURING_LAYOUT
```
    An exception has been raised during layout.
    
    Since:
    
    JViews 5.0
    
    See Also:
    
    getCode(), Constant Field Values
  - GREATEST_CODE
```
public static final int GREATEST_CODE
```
    The largest integer value used as an error code. You can use the value GREATEST_CODE+1 for the definition of a new code.
    
    See Also:
    
    getCode(), Constant Field Values
- Constructor Detail
  - IlvGraphLayoutReport
```
protected IlvGraphLayoutReport()
```
    Creates a new instance of the report object. This is done by IlvGraphLayout.createLayoutReport().
- Method Detail
  - getLayoutTime
```
public long getLayoutTime()
```
    Returns the total duration of the layout algorithm (in milliseconds). The starting and ending times are automatically recorded. The total duration is the sum of the duration of the methods IlvGraphLayout.isLayoutNeeded() and IlvGraphLayout.layout(boolean).
  - getPercentageComplete
```
public int getPercentageComplete()
```
    Returns the current percentage of completion during layout, if the layout algorithm supports the percentage completion feature. This value is set to 0 at the beginning of layout, increases during layout, and reaches 100 at the end of layout.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    IlvGraphLayout.supportsPercentageComplete(), IlvGraphLayout.increasePercentageComplete(int)
  - setCode
```
public void setCode(int code)
```
    Sets the code for the current state of the layout algorithm. Valid code values are those defined in this class (LAYOUT_DONE, STOPPED_AND_VALID, NOT_NEEDED, and so on) or those defined in subclasses of IlvGraphLayoutReport. The codes are mutually exclusive. The last value specified using setCode(int) is returned by getCode().
    Note that you should call this method only if you create your own layout class inside the implementation of IlvGraphLayout.layout(boolean). To obtain the layout report, use IlvGraphLayout.getLayoutReport().
    
    Parameters:
    
    code - The new code for the current state.
    
    See Also:
    
    getCode()
  - getCode
```
public int getCode()
```
    Returns the code describing the current state of the layout algorithm. The possible values are those defined in this class (LAYOUT_DONE, STOPPED_AND_VALID, NOT_NEEDED, and so on) or those defined in subclasses of IlvGraphLayoutReport.
    The method can be called by GraphLayoutEventListener.layoutStepPerformed(ilog.views.graphlayout.GraphLayoutEvent) to inform the listener about the status of layout. This method returns LAYOUT_STARTED if it is called at the beginning of the layout process (unless the layout is not needed).
    It returns LAYOUT_FINISHED if it is called at the end of the layout process (unless the layout is not needed or the graph is empty).
    Whenever the code LAYOUT_STARTED is returned, the code LAYOUT_FINISHED will also be returned, even in cases when an exception occurs during the layout process, the layout is stopped prematurely (by IlvGraphLayout.stopImmediately(), or because the layout time elapsed).
    
    See Also:
    
    setCode(int), IlvGraphLayout.layout(boolean), IlvGraphLayout.supportsStopImmediately(), IlvGraphLayout.supportsAllowedTime(), GraphLayoutEvent.isLayoutStarted(), GraphLayoutEvent.isLayoutFinished()
  - codeToString
```
public String codeToString(int code)
```
    Returns a message string (in English) corresponding to the code value that can be obtained by getCode(). Subclasses of IlvGraphLayoutReport can override and extend this method if they allow additional return values for getCode().
    For example, the method returns the string "layout done" for the input code LAYOUT_DONE and the string "layout not needed" for the input code NOT_NEEDED.
    
    Parameters:
    
    code - The code describing the current state of the layout algorithm.
    
    Returns:
    
    The message string (in English) corresponding to the specified code.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    getCode()
  - codeToString
```
public String codeToString(int code,
                           ULocale locale)
```
    Returns a message string corresponding to the code value that can be obtained by getCode(). Use this method if you need a localized variant of the message strings. Subclasses of IlvGraphLayoutReport can override and extend this method if they allow additional return values for getCode().
    For example, the method returns the string "graph layout done" for the input code LAYOUT_DONE and the string "graph layout not needed" for the input code NOT_NEEDED. If the resource file ilog.views.graphlayout.messages is available for the input locale, the method returns the corresponding translated strings.
    
    Parameters:
    
    code - The code describing the current state of the layout algorithm.
    
    locale - The locale.
    
    Returns:
    
    The message string corresponding to the specified code.
    
    Since:
    
    JViews 8.9
    
    See Also:
    
    getCode()

Class IlvGraphLayoutReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INITIAL_CODE

EMPTY_GRAPHER

NO_MOVEABLE_NODE

NO_RESHAPEABLE_LINK

NOT_NEEDED

LAYOUT_DONE

STOPPED_AND_VALID

STOPPED_AND_INVALID

LAYOUT_STARTED

LAYOUT_FINISHED

EXCEPTION_DURING_LAYOUT

GREATEST_CODE

Constructor Detail

IlvGraphLayoutReport

Method Detail

getLayoutTime

getPercentageComplete

setCode

getCode

codeToString

codeToString