Package org.hkijena.jipipe.api

Interface Summary

Interface	Description
JIPipeFunctionallyComparable	Implement this interface to allow the comparison of function (i.e. two objects can be different, but have the same function and yield the same results) Useful for custom parameter types.
JIPipeRunnable	Runnable that can be scheduled, canceled, and reports progress
JIPipeValidatable	An interface about a type that reports of the validity of its internal state

Class Summary

Class	Description
AbstractJIPipeRunnable	Abstract base class for implementing JIPipeRunnable
JIPipeAuthorMetadata	Models an author with affiliations
JIPipeAuthorMetadata.List
JIPipeDefaultDocumentation	Default implementation of JIPipeDocumentation
JIPipeFixedThreadPool	Contains a fixed thread pool.
JIPipeGraphGCHelper	Used to track garbage collection for the execution of a JIPipeGraph
JIPipeGraphGCHelper.SlotCompletedEvent
JIPipeGraphRunner	Executes an JIPipeGraph.
JIPipeIssueReport	Report about the validity of an object, usually a JIPipeValidatable
JIPipeIssueReport.Issue	A validity report message
JIPipeMetadata	JSON-serializable project metadata
JIPipeNodeTemplate	Contains the JSON data of a node that can be created by a user for sharing An intermediate between copying a node and a proper plugin.
JIPipeNodeTemplate.List
JIPipePercentageProgressInfo	A JIPipeProgressInfo that logs the progress of 0 to 100 percent.
JIPipeProgressInfo	This object is available inside a JIPipeRunnable and contains methods to report progress, logs, and request cancellation.
JIPipeProgressInfo.StatusUpdatedEvent
JIPipeProgressInfoOutputStream
JIPipeProject	A JIPipe project.
JIPipeProject.CompartmentAddedEvent	Triggered when a sample is added to an JIPipeProject
JIPipeProject.CompartmentRemovedEvent	Triggered when a sample is removed from an JIPipeProject
JIPipeProject.Deserializer	Deserializes a project
JIPipeProject.Serializer	Serializes a project
JIPipeProjectMetadata	Metadata for a JIPipeProject
JIPipeProjectPermissions
JIPipeProjectRun	Runnable instance of an JIPipeProject
JIPipeProjectTemplate	A reference to a template project
JIPipeRunnable.EnqueuedEvent	Generated when an JIPipeRunWorker was enqueued
JIPipeRunnable.FinishedEvent	Generated when an JIPipeRunWorker finished its work
JIPipeRunnable.InterruptedEvent	Generated when work of an JIPipeRunWorker is interrupted
JIPipeRunnable.ProgressEvent	Generated when an JIPipeRunWorker reports progress
JIPipeRunnable.StartedEvent	Generated when an JIPipeRunWorker was started
JIPipeRunSettings	Settings for an JIPipeProjectRun

Enum Summary

Enum	Description
JIPipeGraphType	Attached to JIPipeGraph instances to indicate which kind of graph they are

Annotation Types Summary

Annotation Type	Description
JIPipeCitation	Interface to add citations to nodes/data types
JIPipeCitations	Multiple JIPipeCitation
JIPipeCommonData	Annotates a data type as common/preferred.
JIPipeDocumentation	Used within JIPipe to annotate types and methods with documentation
JIPipeDocumentationDescription	Allows to separate the description part of a JIPipeDocumentation into multiple items.
JIPipeDocumentationDescriptions	Container for multiple JIPipeDocumentationDescription
JIPipeHeavyData	Annotates a JIPipeData type as being "heavy" (large file size).
JIPipeHidden	Marks a class as hidden
JIPipeNode	Annotations used for organizing elements