org.cytoscape.application

Interface CyApplicationConfiguration

public interface CyApplicationConfiguration

Application-wide setting will be accessible through this interface.

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: application-api

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

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

Method Summary

Modifier and Type	Method and Description
File	getAppConfigurationDirectoryLocation(Class<?> appClass) Returns the absolute path to the configuration directory of a particular app.
File	getConfigurationDirectoryLocation() Returns absolute path to CytoscapeConfiguration location.
File	getInstallationDirectoryLocation() Returns absolute path to Cytoscape installation directory location.

Method Detail

getInstallationDirectoryLocation

File getInstallationDirectoryLocation()

Returns absolute path to Cytoscape installation directory location.

Returns:

location of Cytoscape installation directory.

getConfigurationDirectoryLocation

File getConfigurationDirectoryLocation()

Returns absolute path to CytoscapeConfiguration location. By default, this is in the user's home directory.

Returns:

location of CytoscapeConfiguration directory. TODO: How can we set this location?

getAppConfigurationDirectoryLocation

File getAppConfigurationDirectoryLocation(Class<?> appClass)

Returns the absolute path to the configuration directory of a particular app. This path might not physically exist and may need to be created by the caller.

Parameters:

appClass - Any class defined by the app's bundle

Returns:

the absolute path to the configuration directory of a particular app.