Cytoscape 3.0.1 API

org.cytoscape.io.datasource
Interface DataSourceManager


public interface DataSourceManager

Entry point to access all data sources implemented as OSGi services. Once someone export DataSource as an OSGi service, this object automatically add the source and it is accessible by users.


Method Summary
 boolean containsDataSource(DataSource pDataSource)
          Check if a DataSource already existed in the DataSourceManager
 boolean deleteDataSource(DataSource pDataSource)
          Remove a DataSource from the DataSourceManager
 Collection<DataCategory> getAllCategories()
          Returns all data categories
 Collection<DataSource> getAllDataSources()
          Returns all data sources registered as OSGi services
 Collection<DataSource> getDataSources(DataCategory category)
          Returns all data sources under the given category.
 Collection<DataSource> getDataSources(String providerName)
          Returns all data sources from a data provider
 void saveDataSource(DataSource pDataSource)
          Save a DataSource to the DataSourceManager
 

Method Detail

getDataSources

Collection<DataSource> getDataSources(DataCategory category)
Returns all data sources under the given category.

Parameters:
category - Category of the data source. Network, Table, etc.
Returns:
all data sources under the category.

getDataSources

Collection<DataSource> getDataSources(String providerName)
Returns all data sources from a data provider

Parameters:
providerName - name of the data provider
Returns:
all data source from the given data provider

getAllDataSources

Collection<DataSource> getAllDataSources()
Returns all data sources registered as OSGi services

Returns:
all data sources

getAllCategories

Collection<DataCategory> getAllCategories()
Returns all data categories

Returns:
all Data Categories

deleteDataSource

boolean deleteDataSource(DataSource pDataSource)
Remove a DataSource from the DataSourceManager

Returns:
true if the dataSource is removed successfully

saveDataSource

void saveDataSource(DataSource pDataSource)
Save a DataSource to the DataSourceManager


containsDataSource

boolean containsDataSource(DataSource pDataSource)
Check if a DataSource already existed in the DataSourceManager

Returns:
true if the dataSource is in the DataSourceManager

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.