Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.core.io.impl
Class SubtaskProgressIndicator

java.lang.Object
  extended by eu.esdihumboldt.hale.common.core.io.impl.ProgressIndicatorDecorator
      extended by eu.esdihumboldt.hale.common.core.io.impl.SubtaskProgressIndicator
All Implemented Interfaces:
ProgressIndicator

public class SubtaskProgressIndicator
extends ProgressIndicatorDecorator

Progress indicator with support for a subtask name.

Author:
Simon Templer

Field Summary
 
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.ProgressIndicator
UNKNOWN
 
Constructor Summary
SubtaskProgressIndicator(ProgressIndicator decoratee)
          Create a progress indicator with support for a subtask name.
 
Method Summary
 void begin(String taskName, int totalWork)
          Start the progress tracking
protected  String getCombinedTaskName(String taskName, String subtaskName)
          Get the combined task name for a sub task
 void setCurrentTask(String taskName)
          Sets the current task name
 void subTask(String subtaskName)
          Start a sub task
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.ProgressIndicatorDecorator
advance, end, isCanceled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubtaskProgressIndicator

public SubtaskProgressIndicator(ProgressIndicator decoratee)
Create a progress indicator with support for a subtask name.

Parameters:
decoratee - the progress indicator to decorate
Method Detail

begin

public void begin(String taskName,
                  int totalWork)
Description copied from interface: ProgressIndicator
Start the progress tracking

Specified by:
begin in interface ProgressIndicator
Overrides:
begin in class ProgressIndicatorDecorator
Parameters:
taskName - the main task name
totalWork - the total work units for the progress indicator, if unknown use ProgressIndicator.UNKNOWN
See Also:
ProgressIndicatorDecorator.begin(String, int)

setCurrentTask

public void setCurrentTask(String taskName)
Description copied from interface: ProgressIndicator
Sets the current task name

Specified by:
setCurrentTask in interface ProgressIndicator
Overrides:
setCurrentTask in class ProgressIndicatorDecorator
Parameters:
taskName - the task name
See Also:
ProgressIndicatorDecorator.setCurrentTask(String)

subTask

public void subTask(String subtaskName)
Start a sub task

Parameters:
subtaskName - the sub task name

getCombinedTaskName

protected String getCombinedTaskName(String taskName,
                                     String subtaskName)
Get the combined task name for a sub task

Parameters:
taskName - the main task name
subtaskName - the sub task name
Returns:
the combined task name

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d