net.sf.basedb.core.filehandler
Interface DataFileMetadataReader

All Superinterfaces:

DataFileHandler

All Known Implementing Classes:

CdfFileHandler, CelFileHandler

public interface DataFileMetadataReader
extends DataFileHandler

This interface should be implemented by classes that are used to extract metadata from a file of a specific DataFileType. The class to use for validation is specified by the DataFileType.getMetadataReaderClass() property.

Version:

2.5

Author:

Nicklas

Last modified

$Date: 2008-09-11 22:09:17 +0200 (Thu, 11 Sep 2008) $

Method Summary

void	extractMetadata(DbControl dc) Extract metadata from the file(s) and write the metadata to the item passed to the DataFileHandler.setItem(net.sf.basedb.core.FileStoreEnabled) method.
void	resetMetadata(DbControl dc) Reset all metadata that this class normally can set.

Methods inherited from interface net.sf.basedb.core.filehandler.DataFileHandler

setFile, setItem

Method Detail

extractMetadata

void extractMetadata(DbControl dc)

Extract metadata from the file(s) and write the metadata to the item passed to the DataFileHandler.setItem(net.sf.basedb.core.FileStoreEnabled) method.

Parameters:

dc - A DbControl object that can be used for database access

resetMetadata

void resetMetadata(DbControl dc)

Reset all metadata that this class normally can set. This method is called if the validation of a file failed. Any previous metadata that may signal that a valid file is present should be reset.

Parameters:

dc - A DbControl object that can be used for database access