org.jbei.ice.lib.bulkupload

Class FileBulkUpload

java.lang.Object

org.jbei.ice.lib.bulkupload.FileBulkUpload

public class FileBulkUpload
extends Object

Processes bulk uploads. Supported file formats are csv, zip and xml, with the latter being for SBOL

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
FileBulkUpload(String account, Path path, EntryType addType)

Method Summary

Modifier and Type	Method and Description
static byte[]	getCSVTemplateBytes(EntryType addType, EntryType linked, boolean linkToExisting) Creates a CSV template for download based on the the type of entries
ProcessedBulkUpload	process() Process bulk file upload.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBulkUpload

public FileBulkUpload(String account,
                      Path path,
                      EntryType addType)

Method Detail

process

public ProcessedBulkUpload process()
                            throws IOException

Process bulk file upload. Uses the file extension to determine the type of file being uploaded.

• Files with a .csv extension are processed as comma separated value files
• Files with a .zip extension are processed as zip files. They are expected to contain exactly 1 csv file and optional attachment/sequence files whose names are referenced in the csv file
• Files with a .xml extension are processed as SBOL files

Returns:

wrapper around processed upload

Throws:

IOException

getCSVTemplateBytes

public static byte[] getCSVTemplateBytes(EntryType addType,
                                         EntryType linked,
                                         boolean linkToExisting)

Creates a CSV template for download based on the the type of entries

Parameters:

addType - entry type that is to be uploaded

linked - optional type that is linked to this entry. Should be one of EntryType or null

linkToExisting - true, if addType is to be linked to an existing entry

Returns:

byte array of the template or null if the headers for the type cannot be retrieved/is unsupported

Throws:

IllegalArgumentException - if the addType is invalid