Package org.cytoscape.io.read

Class AbstractInputStreamTaskFactory

java.lang.Object
org.cytoscape.io.read.AbstractInputStreamTaskFactory
All Implemented Interfaces:
CyFileFilterProvider, InputStreamTaskFactory
public abstract class AbstractInputStreamTaskFactory extends Object implements InputStreamTaskFactory
TODO: Missing documentation

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to 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: 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>

  • Constructor Details

    • AbstractInputStreamTaskFactory

      public AbstractInputStreamTaskFactory​(CyFileFilter fileFilter)

  • Method Details

    • isReady

      public boolean isReady​(InputStream is, String inputName)
      Returns true if the factory is ready to be produce a TaskIterator and false otherwise.
      Specified by:
      isReady in interface InputStreamTaskFactory
      Parameters:
      is - The InputStream to be read.
      inputName - The name of the input.
      Returns:
      true if the factory is ready to be produce a TaskIterator and false otherwise.

    • getFileFilter

      public CyFileFilter getFileFilter()
      Return the file filter associated with the IOFactory.
      Specified by:
      getFileFilter in interface CyFileFilterProvider
      Returns:
      the CyFileFilter associated with the IOFactory.