Package mgui.io.domestic.datasources

Class DataSourceLoader

java.lang.Object

mgui.io.FileLoader

mgui.io.domestic.datasources.DataSourceLoader

All Implemented Interfaces:

InterfaceIO, IconObject

public class DataSourceLoader
extends FileLoader

Loads a Data Source object.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataSourceLoader.FileType

Field Summary

Fields

Modifier and Type	Field	Description
DataSourceLoader.FileType	type

Fields inherited from class mgui.io.FileLoader

dataFile, dataURL, options

Constructor Summary

Constructors

Constructor	Description
DataSourceLoader()
DataSourceLoader(java.io.File file)
DataSourceLoader(java.io.File file, DataSourceLoader.FileType type)
DataSourceLoader(DataSourceLoader.FileType type)

Method Summary

Modifier and Type	Method	Description
java.util.ArrayList<java.lang.Class<?>>	getSupportedObjects()	Returns a list of classes for objects which are supported by this I/O interface
boolean	load(InterfaceIOOptions options, ProgressUpdater progress_bar)	Loads data from the set of files or URLs specified by options.
java.lang.Object	loadObject(ProgressUpdater progress_bar, InterfaceIOOptions options)	Loads data into an instance of the object corresponding to this loader.
java.lang.Object	loadObjectXml(ProgressUpdater progress_bar)	Loads this data source from an XML format file

Methods inherited from class mgui.io.FileLoader

getComplementIOType, getFailureMessage, getFile, getIOType, getObjectIcon, getOptions, getProgressMessage, getSuccessMessage, getTitle, getWriterComplement, load, load, loadObject, loadObject, loadObject, setFile, setOptions, setURL, toString

Methods inherited from class java.lang.Object

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

Field Details

type

public DataSourceLoader.FileType type

Constructor Details

DataSourceLoader

public DataSourceLoader()

DataSourceLoader

public DataSourceLoader(DataSourceLoader.FileType type)

DataSourceLoader

public DataSourceLoader(java.io.File file)

DataSourceLoader

public DataSourceLoader(java.io.File file,
DataSourceLoader.FileType type)

Method Details

load

public boolean load(InterfaceIOOptions options,
ProgressUpdater progress_bar)

Description copied from class: FileLoader

Loads data from the set of files or URLs specified by options. Loading is controlled by the specifications of options. If loaded object is of type PersistentObject, this method should also set the file loader and reference URL for the object.

This method should also set the URL reference and writer and loader attributes to match this one and its complement.

Specified by:

load in class FileLoader

progress_bar - An optional progress updater. Can be null.

Returns:

loadObject

public java.lang.Object loadObject(ProgressUpdater progress_bar,
InterfaceIOOptions options)
                            throws java.io.IOException

Description copied from class: FileLoader

Loads data into an instance of the object corresponding to this loader. If loaded object is of type PersistentObject, this method should also set the file loader and reference URL for the object. TODO: make generic?

Overrides:

loadObject in class FileLoader

Parameters:

progress_bar - An optional progress updater. Can be null.

options - Options defining the loading process

Returns:

Throws:

java.io.IOException

loadObjectXml

public java.lang.Object loadObjectXml(ProgressUpdater progress_bar)
                               throws java.io.IOException

Loads this data source from an XML format file

Parameters:

progress_bar -

Returns:

Throws:

java.io.IOException

getSupportedObjects

public java.util.ArrayList<java.lang.Class<?>> getSupportedObjects()

Description copied from interface: InterfaceIO

Returns a list of classes for objects which are supported by this I/O interface

Specified by:

getSupportedObjects in interface InterfaceIO

Overrides:

getSupportedObjects in class FileLoader

Returns: