project35.io
Interface RecordImporter

public interface RecordImporter

Defines generic interface for classes that convert data read from various file formats into project35 record structures.

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Method Summary

java.lang.String	getName() gets the name of the import feature.
java.util.ArrayList	importRecords() gets all the records created by importing action
boolean	selectFile() determines whether some import file was selected during the operation.
void	setDirectory(java.io.File directory) sets initial directory used to browse for import files
void	setImportRecordType(java.lang.String importRecordType) sets the type of record that will be created from the import operation

Method Detail

getName

java.lang.String getName()

gets the name of the import feature. This is what appears in the File Menu

Returns:

name of feature

setImportRecordType

void setImportRecordType(java.lang.String importRecordType)

sets the type of record that will be created from the import operation

Parameters:

importRecordType - the tag name of the record

importRecords

java.util.ArrayList importRecords()

gets all the records created by importing action

Returns:

list of records of the type set in setImportRecordType

selectFile

boolean selectFile()

determines whether some import file was selected during the operation.

Returns:

true if file was selected. Otherwise false

setDirectory

void setDirectory(java.io.File directory)

sets initial directory used to browse for import files

Parameters:

directory - the directory to begin looking for import files