Class ImageMosaicEventHandlers

Object
ImageMosaicEventHandlers

public class ImageMosaicEventHandlers extends Object
Base class to handle events
Author:
carlo cancellieri - GeoSolutions SAS
  • Field Details

    • notificationListeners

      protected List<ImageMosaicEventHandlers.ProcessingEventListener> notificationListeners
      List containing all the objects that want to be notified during processing.
    • sendDelayedMessages

      protected boolean sendDelayedMessages
      Set this to false for command line UIs where the delayed event sending may prevent some messages to be seen before the tool exits, to true for real GUI where you don't want the processing to be blocked too long, or when you have slow listeners in general.
  • Constructor Details

    • ImageMosaicEventHandlers

      public ImageMosaicEventHandlers()
  • Method Details

    • addProcessingEventListener

      public final void addProcessingEventListener(ImageMosaicEventHandlers.ProcessingEventListener listener)
      Adding a listener to the ImageMosaicEventHandlers.ProcessingEventListeners' list.
      Parameters:
      listener - to add to the list of listeners.
    • fireEvent

      protected void fireEvent(Level level, String inMessage, double percentage)
      Firing an event to listeners in order to inform them about what we are doing and about the percentage of work already carried out.
      Parameters:
      inMessage - The message to show.
      percentage - The percentage for the process.
    • fireFileEvent

      protected void fireFileEvent(Level level, File file, boolean ingested, String inMessage, double percentage)
      Firing an event to listeners in order to inform them about what we are doing and about the percentage of work already carried out.
      Parameters:
      inMessage - The message to show.
      percentage - The percentage for the process.
    • fireUrlEvent

      protected void fireUrlEvent(Level level, URL url, boolean ingested, String inMessage, double percentage)
      Firing an event to listeners in order to inform them about what we are doing and about the percentage of work already carried out.
      Parameters:
      inMessage - The message to show.
      percentage - The percentage for the process.
    • fireURIEvent

      protected void fireURIEvent(Level level, URI uri, boolean ingested, String inMessage, double percentage)
      Firing an event to listeners in order to inform them about what we are doing and about the percentage of work already carried out.
      Parameters:
      inMessage - The message to show.
      percentage - The percentage for the process.
    • fireException

      protected void fireException(Exception ex)
      Firing an exception event to listeners in order to inform them that processing broke and we can no longer proceed. This is a convenience method, it will call fireException(String, double, Exception) with the exception message and -1 as percentage.
      Parameters:
      ex - the actual exception occurred
    • fireCompleted

      protected void fireCompleted()
      Sends the indexing completion event
    • isSendDelayedMessages

      public boolean isSendDelayedMessages()
    • setSendDelayedMessages

      public void setSendDelayedMessages(boolean sendDelayedMessages)
    • removeAllProcessingEventListeners

      public void removeAllProcessingEventListeners()
      Removing all the listeners.
    • removeProcessingEventListener

      public void removeProcessingEventListener(ImageMosaicEventHandlers.ProcessingEventListener listener)
      Removing a ImageMosaicEventHandlers.ProcessingEventListener from the listeners' list.
      Parameters:
      listener - ImageMosaicEventHandlers.ProcessingEventListener to remove from the list of listeners.