Class FWPipeLinesContainer

java.lang.Object
net.simplace.pipe.control.FWPipeLinesContainer

public class FWPipeLinesContainer extends Object
Holds the pipelines of a functionality (the pipeline elements below pipelines), the initial parameters and the listeners for progress task events.
Author:
Andreas Enders
  • Constructor Details

    • FWPipeLinesContainer

      public FWPipeLinesContainer(org.jdom2.Element aFunctionalityElement, net.simplace.core.FWObservable aObservable, String aSystemID) throws PipeLineCreationException
      Constructs a pipeline container and creates all pipelines.
      Parameters:
      aFunctionalityElement - element containing the pipelines element
      aObservable - initial parameters
      aSystemID - not used (the system id is taken from aObservable)
      Throws:
      PipeLineCreationException - if a pipeline cannot be created
  • Method Details

    • getClonedContainer

      public FWPipeLinesContainer getClonedContainer(net.simplace.core.FWObservable aObservable) throws PipeLineCreationException
      Creates a container with other initial parameters that shares pipelines, log files and listeners with this one.
      Parameters:
      aObservable - initial parameters of the new container
      Returns:
      the new container
      Throws:
      PipeLineCreationException - declared, not thrown
    • registerTaskListener

      public void registerTaskListener(FWProgressTaskListener aFWProgressTaskListener)
      Adds a listener for progress task events.
      Parameters:
      aFWProgressTaskListener - the listener
    • removeTaskListener

      public void removeTaskListener(FWProgressTaskListener aFWProgressTaskListener)
      Removes a listener for progress task events.
      Parameters:
      aFWProgressTaskListener - the listener
    • fireTaskEvent

      protected void fireTaskEvent(FWProgressTaskEvent aProcessTaskEvent)
      Notifies the registered listeners, last to first.
      Parameters:
      aProcessTaskEvent - the event
    • getPipeLine

      public FWPipeLine getPipeLine(String aPipeLineID)
      Parameters:
      aPipeLineID - id of the pipeline
      Returns:
      a clone of the pipeline (see FWPipeLine.clone()), or null if the id is null or unknown (warning logged)
    • getObservable

      public net.simplace.core.FWObservable getObservable()
      Returns:
      the initial observable
    • getSystemID

      public String getSystemID()
      Returns:
      the system id of the initial parameters