Package org.anchoranalysis.plugin.io.bean.file.copy.naming

Class CopyFilesNaming<T>

Object

AnchorBean<CopyFilesNaming<T>>

CopyFilesNaming<T>

Type Parameters:

T - shared-state

Direct Known Subclasses:

Anonymize, ClusterByTimestamp, CopyFilesNamingWithoutSharedState

public abstract class CopyFilesNaming<T>
extends AnchorBean<CopyFilesNaming<T>>

How an output name (and path) is selected for an input file when copying.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
CopyFilesNaming()

Method Summary

Modifier and Type	Method	Description
abstract T	beforeCopying(Path destinationDirectory, List<FileWithDirectoryInput> inputs)	To be called once before any calls to destinationPath(File, DirectoryWithPrefix, int, CopyContext).
Optional<Path>	destinationPath(File file, DirectoryWithPrefix outputTarget, int index, CopyContext<T> context)	Returns the output path (destination to to be copied to) for a given single file.
abstract Optional<Path>	destinationPathRelative(File file, DirectoryWithPrefix outputTarget, int index, CopyContext<T> context)	Calculates the relative-output path (to be appended to destDir)

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CopyFilesNaming

public CopyFilesNaming()

Method Details

beforeCopying

public abstract T beforeCopying(Path destinationDirectory,
 List<FileWithDirectoryInput> inputs)
                         throws OperationFailedException

To be called once before any calls to destinationPath(File, DirectoryWithPrefix, int, CopyContext).

Parameters:

destinationDirectory - the directory to which files are copied.

inputs - the total number of files to copy.

Throws:

OperationFailedException

destinationPath

public Optional<Path> destinationPath(File file,
 DirectoryWithPrefix outputTarget,
 int index,
 CopyContext<T> context)
                               throws OutputWriteFailedException

Returns the output path (destination to to be copied to) for a given single file.

Parameters:

file - file to be copied

outputTarget - the directory and prefix associated with the file for outputting

index - an increasing sequence of numbers for each file beginning at 0

context - the context for the copying

Returns:

the absolute-path. if empty, the file should be skipped.

Throws:

OutputWriteFailedException

destinationPathRelative

public abstract Optional<Path> destinationPathRelative(File file,
 DirectoryWithPrefix outputTarget,
 int index,
 CopyContext<T> context)
                                                throws OutputWriteFailedException

Calculates the relative-output path (to be appended to destDir)

Parameters:

file - file to be copied

outputTarget - the directory and prefix associated with the file for outputting

index - an increasing sequence of numbers for each file beginning at 0

context - the context for the copying

Returns:

the relative-path. if empty, the file should be skipped.

Throws:

OutputWriteFailedException