Package org.cytoscape.task.read
Interface LoadVizmapFileTaskFactory
-
- All Superinterfaces:
TaskFactory
public interface LoadVizmapFileTaskFactory extends TaskFactory
An interface for loading styles from files. This interface also provides a task iterator for loading files into visual styles.Module:
core-task-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>core-task-api</artifactId> </dependency>
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TaskIterator
createTaskIterator(File file)
Creates a task iterator for loading files into visual styles.TaskIterator
createTaskIterator(File file, TaskObserver observer)
Creates a task iterator for loading files into visual styles.Set<VisualStyle>
loadStyles(File f)
Return a set of VisualStyle objects read from the specified file.Set<VisualStyle>
loadStyles(InputStream is)
Return a set of VisualStyle objects read from the specified file.-
Methods inherited from interface org.cytoscape.work.TaskFactory
createTaskIterator, isReady
-
-
-
-
Method Detail
-
loadStyles
Set<VisualStyle> loadStyles(File f)
Return a set of VisualStyle objects read from the specified file.- Parameters:
f
- The file containing visual styles to be read.- Returns:
- a set of VisualStyle objects read from the specified file.
-
loadStyles
Set<VisualStyle> loadStyles(InputStream is)
Return a set of VisualStyle objects read from the specified file.- Parameters:
is
- The inputStream containing visual styles to be read.- Returns:
- a set of VisualStyle objects read from the specified file.
-
createTaskIterator
TaskIterator createTaskIterator(File file)
Creates a task iterator for loading files into visual styles. The created task runs synchronously in the current thread and does not create a task monitor.- Parameters:
file
- The file containing visual styles to be read.- Returns:
- A task iterator of type
TaskIterator
.
-
createTaskIterator
TaskIterator createTaskIterator(File file, TaskObserver observer)
Creates a task iterator for loading files into visual styles. The created task runs synchronously in the current thread and does not create a task monitor.- Parameters:
file
- The file containing visual styles to be read.observer
- A TaskObserver that wants to know when we're done- Returns:
- A task iterator of type
TaskIterator
.
-
-