Package com.orchestranetworks.addon.dmdv

Class GraphSpec

java.lang.Object

com.orchestranetworks.addon.dmdv.GraphSpec

Direct Known Subclasses:

GraphDataSpec, GraphModelSpec

public abstract class GraphSpec
extends Object

Abstract class for graph specifications.

Constructor Summary

Constructors

Constructor	Description
GraphSpec()

Method Summary

Modifier and Type	Method	Description
String	getGraphConfigurationName()	Returns the current configuration name from the add-on's administrative settings.
boolean	isDisplayGraphTitle()	Returns true if graph title must be displayed; false otherwise.
boolean	isForceRecursiveExpand()	Gets whether or not to force the graph to expand recursively.
void	setDisplayGraphTitle(boolean displayGraphTitle)	Sets the option to display the graph title.
void	setForceRecursiveExpand(boolean forceRecursiveExpand)	Sets whether or not to force the graph to expand recursively.
void	setGraphConfigurationName(String graphConfigurationName)	Sets the graph configuration name.
void	setOverviewDisplay(OverviewDisplayOptions displayOptions)	Sets the option to display the graph's Overview box on graph generation.

Methods inherited from class java.lang.Object

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

Constructor Details

GraphSpec

public GraphSpec()

Method Details

getGraphConfigurationName

public String getGraphConfigurationName()

Returns the current configuration name from the add-on's administrative settings.

setGraphConfigurationName

public void setGraphConfigurationName(String graphConfigurationName)

Sets the graph configuration name. If null, the service will generate a graph without a configuration.

Parameters:

graphConfigurationName - a specific name for the graph

isDisplayGraphTitle

public boolean isDisplayGraphTitle()

Returns true if graph title must be displayed; false otherwise.

setDisplayGraphTitle

public void setDisplayGraphTitle(boolean displayGraphTitle)

Sets the option to display the graph title. Defaults to false.

Parameters:

displayGraphTitle - set to true if graph title must be displayed; false otherwise.

setOverviewDisplay

public void setOverviewDisplay(OverviewDisplayOptions displayOptions)

Sets the option to display the graph's Overview box on graph generation. Defaults to OverviewDisplayOptions.ENABLE

Parameters:

displayOptions - set to OverviewDisplayOptions.ENABLE if graph overview must be displayed; OverviewDisplayOptions.DISABLE if graph overview must be hidden; OverviewDisplayOptions.MINIMIZE if graph overview must be minimized.

Since:

1.3.0

See Also:

• OverviewDisplayOptions

isForceRecursiveExpand

public boolean isForceRecursiveExpand()

Gets whether or not to force the graph to expand recursively.

Returns:

Whether or not to force the graph to expand recursively.

Since:

6.2.0

setForceRecursiveExpand

public void setForceRecursiveExpand(boolean forceRecursiveExpand)

Sets whether or not to force the graph to expand recursively.

The default value is true.

Parameters:

forceRecursiveExpand - Whether or not to force the graph to expand recursively.

Since:

6.2.0