org.jbei.ice.lib.entry

Class EntriesAsCSV

java.lang.Object

org.jbei.ice.lib.entry.EntriesAsCSV

public class EntriesAsCSV
extends Object

Representation of a list of entries as a CSV file with option to include associated sequences

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
EntriesAsCSV(String userId, String... formats)

Method Summary

Modifier and Type	Method and Description
ByteArrayOutputStream	customize(EntrySelection selection)
protected String[]	getCSVHeaders(EntryField[] fields)
protected EntryField[]	getEntryFields()
Path	getFilePath()
protected void	putZipEntry(ByteArrayWrapper wrapper, ZipOutputStream zos)
boolean	setEntries(List<Long> entries, EntryField... fields) Directly set the list of entries whose fields and (optionally) sequences are to be extracted
boolean	setSelectedEntries(EntrySelection selection, EntryField... fields) Set source of entries, extract to csv

Methods inherited from class java.lang.Object

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

Constructor Detail

EntriesAsCSV

public EntriesAsCSV(String userId,
                    String... formats)

Parameters:

formats - optional list of formats of sequences to include

Method Detail

setSelectedEntries

public boolean setSelectedEntries(EntrySelection selection,
                                  EntryField... fields)

Set source of entries, extract to csv

Parameters:

selection - selection indicating source of entries

fields - optional list of fields used to filter the data

Returns:

true if extraction happened successfully and can be retrieved with a call to getFilePath false otherwise

setEntries

public boolean setEntries(List<Long> entries,
                          EntryField... fields)

Directly set the list of entries whose fields and (optionally) sequences are to be extracted

Parameters:

entries - list of entry ids

fields - optional list of fields used to filter the data

Returns:

true if extraction happened successfully and can be retrieved with a call to getFilePath false otherwise

getCSVHeaders

protected String[] getCSVHeaders(EntryField[] fields)

putZipEntry

protected void putZipEntry(ByteArrayWrapper wrapper,
                           ZipOutputStream zos)

getEntryFields

protected EntryField[] getEntryFields()

customize

public ByteArrayOutputStream customize(EntrySelection selection)
                                throws IOException

Throws:

IOException

getFilePath

public Path getFilePath()