org.dataconservancy.pass.deposit.provider.nihms

Class NihmsPackageProvider

java.lang.Object

org.dataconservancy.pass.deposit.provider.nihms.NihmsPackageProvider

All Implemented Interfaces:

org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

public class NihmsPackageProvider
extends Object
implements org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

Author:

Elliot Metsger (emetsger@jhu.edu)

Nested Class Summary

Nested classes/interfaces inherited from interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource

Constructor Summary

Constructors

Constructor and Description
NihmsPackageProvider()

Method Summary

Modifier and Type	Method and Description
List<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource>	finish(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources)
static String	getNonCollidingFilename(String fileName, org.dataconservancy.pass.deposit.model.DepositFileType fileType) Given a file name and type, returns a file name that can safely be used in a NIHMS deposit without causing a collision with the names of files that are automatically included in the deposit package.
String	packagePath(org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource custodialResource)
void	start(org.dataconservancy.pass.deposit.model.DepositSubmission submission, List<org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource> custodialResources, Map<String,Object> packageOptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

NihmsPackageProvider

public NihmsPackageProvider()

Method Detail

getNonCollidingFilename

public static String getNonCollidingFilename(String fileName,
                                             org.dataconservancy.pass.deposit.model.DepositFileType fileType)

Given a file name and type, returns a file name that can safely be used in a NIHMS deposit without causing a collision with the names of files that are automatically included in the deposit package. If a collision is detected, the returned name is a modification of the supplied name. Since multiple files in a submission may already have the same name, no effort is made to ensure that the collision-free name is unique.

Parameters:

fileName - the name of a file to be included in the deposit, which may conflict with a reserved name.

fileType - the type of the file whose name is being validated.

Returns:

the existing file name, or a modified version if the existing name collides with a reserved name.

start

public void start(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                  List<org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource> custodialResources,
                  Map<String,Object> packageOptions)

Specified by:

start in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

packagePath

public String packagePath(org.dataconservancy.pass.deposit.assembler.shared.DepositFileResource custodialResource)

Returns the file name for the resource, or a modified version thereof if the name matches that of one of the default files that are included in a NIHMS deposit. The file type is not known at this point in the code, but we do know that it must be user-supplied and therefore not "bulksub_meta_xml" (the only type that warrants special treatment in getNoncollidingFilename()). So, the type is always passed as "supplement" to avoid that special treatment.

Specified by:

packagePath in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider

Parameters:

custodialResource - the resource for which a safe file name will be returned.

Returns:

a collision-free name for the provided resource file.

finish

public List<org.dataconservancy.pass.deposit.assembler.shared.PackageProvider.SupplementalResource> finish(org.dataconservancy.pass.deposit.model.DepositSubmission submission,
                                                                                                           List<org.dataconservancy.pass.deposit.assembler.PackageStream.Resource> packageResources)

Specified by:

finish in interface org.dataconservancy.pass.deposit.assembler.shared.PackageProvider