Package org.geotools.data.util

Class DelegateProgressListener

Object
DelegateProgressListener
All Implemented Interfaces:
ProgressListener
Direct Known Subclasses:
SubProgressListener
public class DelegateProgressListener extends Object implements ProgressListener
Base class for progress listeners that delegate to other progress listeners

  • Field Details

  • Constructor Details

    • DelegateProgressListener

      public DelegateProgressListener(ProgressListener progress)

  • Method Details

    • started

      public void started()
      Description copied from interface: ProgressListener
      Notifies this listener that the operation begins.
      Specified by:
      started in interface ProgressListener

    • complete

      public void complete()
      Description copied from interface: ProgressListener
      Notifies this listener that the operation has finished. The progress indicator will shows 100% or disappears, at implementor choice. If warning messages were pending, they will be displayed now.
      Specified by:
      complete in interface ProgressListener

    • dispose

      public void dispose()
      Description copied from interface: ProgressListener
      Releases any resources used by this listener. If the progress were reported in a window, this window may be disposed.
      Specified by:
      dispose in interface ProgressListener

    • exceptionOccurred

      public void exceptionOccurred(Throwable exception)
      Description copied from interface: ProgressListener
      Reports an exception. This method may prints the stack trace to the standard error stream or display it in a dialog box, at implementor choice.
      Specified by:
      exceptionOccurred in interface ProgressListener
      Parameters:
      exception - The exception to report.

    • getTask

      public InternationalString getTask()
      Description copied from interface: ProgressListener
      Returns the description of the current task being performed, or null if none. It is assumed that if the task is null applications may simply report that the process is "in progress" or "working" as represented in the current locale.
      Specified by:
      getTask in interface ProgressListener
      Returns:
      Description of the task being performed, or null if none.

    • isCanceled

      public boolean isCanceled()
      Description copied from interface: ProgressListener
      Returns true if this job is cancelled.
      Specified by:
      isCanceled in interface ProgressListener
      Returns:
      true if this job is cancelled.

    • progress

      public void progress(float progress)
      Description copied from interface: ProgressListener
      Notifies this listener of progress in the lengthly operation. Progress are reported as a value between 0 and 100 inclusive. Values out of bounds will be clamped.
      Specified by:
      progress in interface ProgressListener
      Parameters:
      progress - The progress as a value between 0 and 100 inclusive.

    • getProgress

      public float getProgress()
      Description copied from interface: ProgressListener
      Returns the current progress as a percent completed.
      Specified by:
      getProgress in interface ProgressListener
      Returns:
      Percent completed between 0 and 100 inclusive.

    • setCanceled

      public void setCanceled(boolean cancel)
      Description copied from interface: ProgressListener
      Indicates that task should be cancelled.
      Specified by:
      setCanceled in interface ProgressListener
      Parameters:
      cancel - true for cancelling the task.

    • setTask

      public void setTask(InternationalString task)
      Description copied from interface: ProgressListener
      Sets the description of the current task being performed. This method is usually invoked before any progress begins. However, it is legal to invoke this method at any time during the operation, in which case the description display is updated without any change to the percentage accomplished.
      Specified by:
      setTask in interface ProgressListener
      Parameters:
      task - Description of the task being performed, or null if none.

    • warningOccurred

      public void warningOccurred(String source, String location, String warning)
      Description copied from interface: ProgressListener
      Reports a warning. This warning may be logged, printed to the standard error stream, appears in a windows or be ignored, at implementor choice.
      Specified by:
      warningOccurred in interface ProgressListener
      Parameters:
      source - Name of the warning source, or null if none. This is typically the filename in process of being parsed or the URL of the data being processed
      location - Text to write on the left side of the warning message, or null if none. This is typically the line number where the error occured in the source file or the feature ID of the feature that produced the message
      warning - The warning message.

    • getDelegate

      public ProgressListener getDelegate()