net.sf.basedb.util.bfs
Interface ExtraFileImporter

All Known Implementing Classes:

GenericExtraFileImporter

public interface ExtraFileImporter

Implementors are responsible for importing extra files specified in the BFS metadata file into the BASE file system.

Since:

2.15

Author:

Nicklas

Last modified

$Date: 2010-02-09 11:45:56 +0100 (Tue, 09 Feb 2010) $

Method Summary

File	importExtraFile(String filename, InputStreamLocator locator) Import the file data into a file in the BASE file system.

Method Detail

importExtraFile

File importExtraFile(String filename,
                     InputStreamLocator locator)
                     throws IOException

Import the file data into a file in the BASE file system. The BfsImporter will call this method once for each extra file (entries starting with 'x-') in the metadata file. The implementation is supposed to create a file in the BASE file system or link to an existing file. The returned file will be automatically linked with the child bioassay set.

Parameters:

filename - The filename of the file that is being imported

locator - A locator implementation that should be used to find the file data if needed

Returns:

The file in the BASE file system or null if no file was created

Throws:

IOException - If there is a problem reading the file data