Package org.anchoranalysis.plugin.io.shared

Class RecordingCounter<T>

Object

RecordingCounter<T>

Type Parameters:

T - shared-state of CopyFilesNaming

public class RecordingCounter<T>
extends Object

A counter that also records outputs in a message-log and CSV file.

The following outputs are produced:

Output Name	Default?	Description
"copyLog"	no	a text log file showing each copy operation (and any skipped files).
"pathMapping"	no	a CSV file showing the source and destination paths for each copy operation (skipped files are not included)..

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
RecordingCounter(Counter counter, Outputter outputter, T namingSharedState)

Method Summary

Modifier and Type	Method	Description
void	closeLogger()	Closes the logger.
T	getNamingSharedState()
int	incrementCounter()	Increments the counter.
void	recordCopiedOutput(Path source, Optional<Path> destination, int index)	Records an copy operation in the log / CSV path mapping.

Methods inherited from class java.lang.Object

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

Constructor Details

RecordingCounter

public RecordingCounter(Counter counter,
 Outputter outputter,
 T namingSharedState)
                 throws OperationFailedException

Throws:

OperationFailedException

Method Details

incrementCounter

public int incrementCounter()

Increments the counter.

This is thread-safe.

Returns:

the index of the counter before being incremented.

recordCopiedOutput

public void recordCopiedOutput(Path source,
 Optional<Path> destination,
 int index)
                        throws OperationFailedException

Records an copy operation in the log / CSV path mapping.

This also performs a check that multiple files are writing to the same output destination.

Parameters:

source - source-path for copying operation

destination - destination-path for copying operation

index - the index of file (an integer number uniquely assigned to each operation)

Throws:

OperationFailedException - if this method has been previously called with an identical destination (only if it's not-empty).

closeLogger

public void closeLogger()

Closes the logger.

getNamingSharedState

public T getNamingSharedState()