Package pulse.tasks

Class TaskManager

  • All Implemented Interfaces:
    Serializable, Descriptive
    public final class TaskManager
extends UpwardsNavigable

    The TaskManager is a high-level class for dealing with operations of creation, removal, storage, and execution of SearchTasks, as well as with the associated Results and InterpolationDatasets. Note that TaskManager adopts a PathSolver.

    See Also:
    Serialized Form

    • Method Detail

      • derivableProperties

        public List<NumericPropertyKeyword> derivableProperties()
        Creates a list of property keywords that can be derived with help of the loaded data. For example, if heat capacity and density data is available, the returned list will contain CONDUCTIVITY.
        Returns:

      • getManagerInstance

        public static TaskManager getManagerInstance()
        This class uses a singleton pattern, meaning there is only instance of this class.
        Returns:
        the single (static) instance of this class

      • execute

        public void execute​(SearchTask t)
        Executes t asynchronously using a CompletableFuture. When done, creates a Result and puts it into the Map(SearchTask,Result) in this TaskManager.
        Parameters:
        t - a SearchTask that will be executed

      • notifyListeners

        public void notifyListeners​(TaskRepositoryEvent e)
        Notifies the TaskRepositoryListeners of the e
        Parameters:
        e - an event

      • executeAll

        public void executeAll()

        Creates a queue of SearchTasks based on their readiness and feeds that queue to a ForkJoinPool using a parallel stream. The size of the pool is usually limited by hardware, e.g. for a 4 core system with 2 independent threads on each core, the limitation will be 4*2 - 1 = 7, etc.

      • isTaskQueueEmpty

        public boolean isTaskQueueEmpty()
        Checks if any of the tasks that this TaskManager manages is either QUEUED or IN_PROGRESS.
        Returns:
        false if the status of the SearchTask is any of the above; false otherwise.

      • cancelAllTasks

        public void cancelAllTasks()
        This will terminate all tasks in this TaskManager and trigger a SHUTDOWN TaskRepositoryEvent.

      • fireTaskSelected

        public void fireTaskSelected​(Object source)

      • clear

        public void clear()

        Purges all tasks from this TaskManager. Generates a TASK_REMOVED TaskRepositoryEvent for each of the removed tasks. Clears task selection.

      • getSampleName

        public SampleName getSampleName()
        Uses the first non-null SearchTask to retrieve the sample name from the Metadata associated with its ExperimentalData.
        Returns:
        a String with the sample name, or null if no suitable task can be found.

      • reset

        public void reset()

        Clears any progress for all the tasks and resets everything. Triggers a TASK_RESET event.

      • getTask

        public SearchTask getTask​(Identifier id)
        Finds a SearchTask whose Identifier matches id.
        Parameters:
        id - the Identifier of the task.
        Returns:
        the SearchTask associated with this Identifier.

      • getTask

        public SearchTask getTask​(int externalId)
        Finds a SearchTask using the external identifier specified in its metadata.
        Parameters:
        externalId - the external ID of the data.
        Returns:
        the SearchTask associated with this Identifier.

      • generateTask

        public void generateTask​(File file)

        Generates a SearchTask assuming that the ExperimentalData is stored in the file. This will make the ReaderManager attempt to read that file. If successful, invokes addTask(...) on the created SearchTask. After the task is generated, checks whether the acquisition time recorded by the experimental setup has been chosen appropriately.

        Parameters:
        file - the file to load the experimental data from
        See Also:
        addTask(pulse.tasks.SearchTask)

      • generateTasks

        public void generateTasks​(List<File> files)
        Generates multiple tasks from multiple files.
        Parameters:
        files - a list of Files that can be parsed down to ExperimentalData.

      • addTask

        public SearchTask addTask​(SearchTask t)

        If a task equal to t has already been previously loaded, does nothing. Otherwise, adds this t to the task repository and triggers a TASK_ADDED event.

        Parameters:
        t - the SearchTask that needs to be added to the internal repository
        Returns:
        null if a task like t has already been added previously, t otherwise.

      • removeTask

        public boolean removeTask​(SearchTask t)
        If t is found in the local repository, removes it and triggers a TASK_REMOVED event.
        Parameters:
        t - a SearchTask that has been previously loaded to this repository.
        Returns:
        true if the operation is successful, false otherwise.

      • numberOfTasks

        public int numberOfTasks()
        Gets the current number of tasks in the repository.
        Returns:
        the number of available tasks.

      • selectTask

        public void selectTask​(Identifier id,
                       Object src)

        Selects a SearchTask within this repository with the specified id (if present). Informs the listeners this selection has been triggered by src.

        Parameters:
        id - the Identifier of a task within this repository.
        src - the source of the selection.

      • selectFirstTask

        public void selectFirstTask()

      • addTaskRepositoryListener

        public final void addTaskRepositoryListener​(TaskRepositoryListener listener)

      • removeSelectionListeners

        public void removeSelectionListeners()

      • indexOfTask

        public int indexOfTask​(SearchTask t)

      • getSelectedTask

        public SearchTask getSelectedTask()

      • evaluate

        public void evaluate()

      • allGrouppedContents

        public Set<Group> allGrouppedContents()

      • isSingleStatement

        public boolean isSingleStatement()
        Checks whether changes in this PropertyHolder should automatically be accounted for by other instances of this class.
        Returns:
        true if the user has specified so (set by default), false otherwise

      • assumeNewState

        public static void assumeNewState​(TaskManager loaded)

      • addSessionListener

        public static void addSessionListener​(SessionListener sl)

      • removeSessionListeners

        public static void removeSessionListeners()

      • setSingleStatement

        public void setSingleStatement​(boolean singleStatement)
        Sets the flag to isolate or inter-connects changes in all instances of PropertyHolder
        Parameters:
        singleStatement - false if other PropertyHoders should disregard changes, which happened to this instances. true otherwise.