public interface IAnalysisTool
IAnalysisTools are tools that can be used to analyze data. There is one instance of each IAnalysisTool in ICE and they are responsible for creating IAnalysisDocument for their respective tool. Each IAnalysisTool should have a name and a version number that are unique so that they can be distinguished from each other.
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
close()
This operation allows subclasses to perform shutdown operations when they are required by a back-end analysis service (such as VisIt) to close the running processes.
|
IAnalysisDocument |
createDocument(IDataProvider data)
This operation creates a new IAnalysisDocument for the data within the given IDataProvider realization.
|
IAnalysisDocument |
createDocument(java.net.URI data)
This operation create a new IAnalysisDocument for the data at the given URI.
|
java.lang.String |
getName()
This operation returns the name of the analysis tool.
|
java.lang.String |
getVersion()
This operation returns the version number of the analysis tool.
|
boolean |
isReady()
This operation notifies a client if the IAnalysisTool is ready to be used.
|
java.lang.Boolean close()
This operation allows subclasses to perform shutdown operations when they are required by a back-end analysis service (such as VisIt) to close the running processes.
java.lang.String getName()
This operation returns the name of the analysis tool.
The name of the analysis tool.
java.lang.String getVersion()
This operation returns the version number of the analysis tool.
The version number, as a string, for this analysis tool.
IAnalysisDocument createDocument(java.net.URI data)
This operation create a new IAnalysisDocument for the data at the given URI.
data
- A URI to a folder or file that contains data which should be analyzed in the IAnalysisDocument.
A new analysis document for the data provided by this analysis tool. This IAnalysisDocument is made to work with this analysis tool only.
boolean isReady()
This operation notifies a client if the IAnalysisTool is ready to be used.
True if the tool is ready to be used, false otherwise.
IAnalysisDocument createDocument(IDataProvider data)
This operation creates a new IAnalysisDocument for the data within the given IDataProvider realization.
data
- A concrete realization of IDataProvider that contains data which should be analyzed in the IAnalysisDocument.
A new analysis document for the data provided by this analysis tool. This IAnalysisDocument is made to work with this analysis tool only.