Package ubic.gemma.cli.batch

Class LoggingBatchTaskSummaryWriter

java.lang.Object

ubic.gemma.cli.batch.LoggingBatchTaskSummaryWriter

All Implemented Interfaces:

Closeable, AutoCloseable, BatchTaskSummaryWriter

public class LoggingBatchTaskSummaryWriter
extends Object
implements BatchTaskSummaryWriter

Task summary writer that logs the result of a batch task to a logger.

Author:

poirigui

Constructor Summary

Constructors

Constructor	Description
LoggingBatchTaskSummaryWriter(String logCategory)
LoggingBatchTaskSummaryWriter(String logCategory, boolean useDebugForSuccess)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the writer and write any remaining results.
void	write(BatchTaskProcessingResult result)	Write the result of a batch task.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingBatchTaskSummaryWriter

public LoggingBatchTaskSummaryWriter(String logCategory)

LoggingBatchTaskSummaryWriter

public LoggingBatchTaskSummaryWriter(String logCategory,
                                     boolean useDebugForSuccess)

Parameters:

logCategory - log category to use to report batch processing results

useDebugForSuccess - if true, success are reported as debug logs

Method Detail

write

public void write(BatchTaskProcessingResult result)
           throws IOException

Description copied from interface: BatchTaskSummaryWriter

Write the result of a batch task.

The actual writing may be deferred until the writer is closed in BatchTaskSummaryWriter.close().

Specified by:

write in interface BatchTaskSummaryWriter

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: BatchTaskSummaryWriter

Close the writer and write any remaining results.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BatchTaskSummaryWriter

Specified by:

close in interface Closeable

Throws:

IOException