Package org.cytoscape.io.datasource
Class DefaultDataSource
java.lang.Object
org.cytoscape.io.datasource.DefaultDataSource
- All Implemented Interfaces:
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
ConstructorDescriptionDefaultDataSource
(String name, String provider, String description, DataCategory category, URL url) Constructor for the default data source. -
Method Summary
Modifier and TypeMethodDescriptionDataCategory
of this data.Description for this data.Location of this data file.getName()
Name of this data sourceName of this data provider for this source.
-
Constructor Details
-
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 sourceprovider
- provider name of data sourcedescription
- description for this sourcecategory
- category of dataurl
- location of data file as URL
-
-
Method Details
-
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 interfaceDataSource
- Returns:
- Name of data provider
-
getName
Description copied from interface:DataSource
Name of this data source- Specified by:
getName
in interfaceDataSource
- Returns:
- Name of this data source
-
getDescription
Description copied from interface:DataSource
Description for this data.- Specified by:
getDescription
in interfaceDataSource
- Returns:
- description
-
getDataCategory
Description copied from interface:DataSource
DataCategory
of this data.- Specified by:
getDataCategory
in interfaceDataSource
- Returns:
- category of this data file.
-
getLocation
Description copied from interface:DataSource
Location of this data file.- Specified by:
getLocation
in interfaceDataSource
- Returns:
- URL of this data file
-