ome.smuggler.core.types

Class ImportBatchStatus

java.lang.Object

ome.smuggler.core.types.ImportBatchStatus

public class ImportBatchStatus
extends java.lang.Object

Tracks progress of an ImportBatch.

Constructor Summary

Constructors

Constructor and Description
ImportBatchStatus(ImportBatch batch) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addToCompleted(ProcessedImport task) Updates the batch status to reflect that the specified import has completed either successfully or with a failure depending on the value returned by ProcessedImport.succeeded().
boolean	allProcessed() Have all the imports in this batch been processed?
boolean	allSucceeded() Have all the imports in this batch been processed successfully?
ImportBatch	batch()
boolean	equals(java.lang.Object x)
java.util.Set<QueuedImport>	failed()
int	hashCode()
java.util.Set<QueuedImport>	succeeded()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImportBatchStatus

public ImportBatchStatus(ImportBatch batch)

Creates a new instance.

Parameters:

batch - the batch to track.

Throws:

java.lang.NullPointerException - if the argument is null.

Method Detail

batch

public ImportBatch batch()

Returns:

the batch we're tracking.

addToCompleted

public void addToCompleted(ProcessedImport task)

Updates the batch status to reflect that the specified import has completed either successfully or with a failure depending on the value returned by ProcessedImport.succeeded(). This method will check that all the following conditions are true:

• The queued task is that of an import in the batch.
• If this method was previously called with an argument t, then task.succeeded() == t.succeeded(). In other words, you can call this method multiple times for the same import task as long as the specified import outcome is always the same.

If any of the above is false, then an exceptions is thrown and the status is not updated.

Parameters:

task - the import.

Throws:

java.lang.NullPointerException - if the argument is null.

java.lang.IllegalArgumentException - if any of the above conditions are not met.

allProcessed

public boolean allProcessed()

Have all the imports in this batch been processed?

Returns:

true for yes, false for no.

allSucceeded

public boolean allSucceeded()

Have all the imports in this batch been processed successfully?

Returns:

true for yes, false for no.

succeeded

public java.util.Set<QueuedImport> succeeded()

Returns:

the imports in the batch that completed successfully.

failed

public java.util.Set<QueuedImport> failed()

Returns:

the imports in the batch that terminated with a failure.

equals

public boolean equals(java.lang.Object x)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object