org.cytoscape.io.datasource

Class DefaultDataSource

java.lang.Object

org.cytoscape.io.datasource.DefaultDataSource

All Implemented Interfaces:

DataSource

public final class DefaultDataSource
extends Object
implements DataSource

Basic implementation of DataSource. In general, most of the data sources can be encoded with this default implementation.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: datasource-api

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

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

Constructor Summary

Constructors

Constructor and Description
DefaultDataSource(String name, String provider, String description, DataCategory category, URL url) Constructor for the default data source.

Method Summary

Methods

Modifier and Type	Method and Description
DataCategory	getDataCategory() DataCategory of this data.
String	getDescription() Description for this data.
URL	getLocation() Location of this data file.
String	getName() Name of this data source
String	getProvider() Name of this data provider for this source.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDataSource

public DefaultDataSource(String name,
                 String provider,
                 String description,
                 DataCategory category,
                 URL url)

Constructor for the default data source. All of the parameters should be provided as a non-null value.

Parameters:

name - name of source

provider - provider name of data source

description - description for this source

category - category of data

url - location of data file as URL

Method Detail

getProvider

public String getProvider()

Description copied from interface: DataSource

Name of this data provider for this source. Usually, this is an database name or organization name providing set of data.

Specified by:

getProvider in interface DataSource

Returns:

Name of data provider

getName

public String getName()

Description copied from interface: DataSource

Name of this data source

Specified by:

getName in interface DataSource

Returns:

Name of this data source

getDescription

public String getDescription()

Description copied from interface: DataSource

Description for this data.

Specified by:

getDescription in interface DataSource

Returns:

description

getDataCategory

public DataCategory getDataCategory()

Description copied from interface: DataSource

DataCategory of this data.

Specified by:

getDataCategory in interface DataSource

Returns:

category of this data file.

getLocation

public URL getLocation()

Description copied from interface: DataSource

Location of this data file.

Specified by:

getLocation in interface DataSource

Returns:

URL of this data file