org.cytoscape.io.read

Interface CyPropertyReaderManager

public interface CyPropertyReaderManager

An object that registers all InputStreamReaderFactory singletons, processes specified input to determine the appropriate factory to use and then returns an instance of the correct CyPropertyReader for the input.

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

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

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

Method Summary

Modifier and Type	Method and Description
CyPropertyReader	getReader(InputStream stream, String inputName) Given an InputStream this method will attempt to find a InputStreamReaderFactory that can read the stream, will set the InputStream for the factory and will return the reader.
CyPropertyReader	getReader(URI uri, String inputName) Given a URI this method will attempt to find a InputStreamReaderFactory that can read the URI, will set the InputStream for the factory and will return the reader.

Method Detail

getReader

CyPropertyReader getReader(URI uri,
                           String inputName)

Given a URI this method will attempt to find a InputStreamReaderFactory that can read the URI, will set the InputStream for the factory and will return the reader.

Parameters:

uri - The URI we're attempting to read.

inputName - The name of the input.

Returns:

A reader than can read the specified URI. Will return null if no reader can be found.

getReader

CyPropertyReader getReader(InputStream stream,
                           String inputName)

Given an InputStream this method will attempt to find a InputStreamReaderFactory that can read the stream, will set the InputStream for the factory and will return the reader.

Parameters:

stream - The input stream we're attempting to read.

inputName - The name of the input.

Returns:

A reader than can read the specified stream. Will return null if no reader can be found.