public abstract class GeneiousGridImporter extends Object
DocumentFileImporters
to use for which file:
DocumentFileImporter, but designed for application in Grid plugins.
It works similarly to the DocumentFileImporter, but no autodetecting is performed, and the importer
accepts a folder, rather than a file.| Constructor and Description |
|---|
GeneiousGridImporter() |
| Modifier and Type | Method and Description |
|---|---|
protected abstract void |
_importDocuments(File folder,
DocumentFileImporter.ImportCallback callback,
ProgressListener progressListener)
Import document(s) from a folder.
|
void |
importDocuments(File folder,
DocumentFileImporter.ImportCallback callback,
ProgressListener progressListener)
This method is for internal use by Geneious.
|
public final void importDocuments(File folder, DocumentFileImporter.ImportCallback callback, ProgressListener progressListener) throws IOException, DocumentImportException
_importDocuments(java.io.File, com.biomatters.geneious.publicapi.plugin.DocumentFileImporter.ImportCallback, jebl.util.ProgressListener).folder - .callback - .progressListener - .IOException - .DocumentImportException - .protected abstract void _importDocuments(File folder, DocumentFileImporter.ImportCallback callback, ProgressListener progressListener) throws IOException, DocumentImportException
importDocuments(java.io.File, com.biomatters.geneious.publicapi.plugin.DocumentFileImporter.ImportCallback, jebl.util.ProgressListener)
only when the folder parameter refers to a folder in the filesystem, so an implementation
of this method can safely assume that folder exists and is not a file.folder - the folder to import from (it is guaranteed that this file is a folder and not null)callback - report imported documents to this callback using addDocument().progressListener - call setProgress or similar to report progress for the import.
This may be ignored but is not recommended if the import may
take more than a second or so.IOException - when unable to read the full contents of the file for any reasonDocumentImportException - when unable to generate document(s) from contents of file.