org.cytoscape.session

Interface CyNetworkNaming

public interface CyNetworkNaming

A utility that helps with the creation of unique network names.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: session-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>session-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
String	getSuggestedNetworkTitle(String desiredTitle) Generates a unique network title based on a provided suggestion.
String	getSuggestedSubnetworkTitle(CyNetwork parentNetwork) Generates a unique title for a subnetwork based on a parent network.

Method Detail

getSuggestedSubnetworkTitle

String getSuggestedSubnetworkTitle(CyNetwork parentNetwork)

Generates a unique title for a subnetwork based on a parent network.

Parameters:

parentNetwork - a non-null reference to a parent network.

Returns:

a unique title somehow based on the title of the parent network.

getSuggestedNetworkTitle

String getSuggestedNetworkTitle(String desiredTitle)

Generates a unique network title based on a provided suggestion.

Parameters:

desiredTitle - the "ideal" title that we would like

Returns:

"desiredTitle" if this title is not yet in use, or with a title that is unique and uses "desiredTitle" as a prefix.