Package mgui.io.domestic.shapes

Class InterfaceShapeLoader

java.lang.Object

mgui.io.FileLoader

mgui.io.domestic.shapes.InterfaceShapeLoader

All Implemented Interfaces:

InterfaceIO, IconObject

Direct Known Subclasses:

PointSet2DLoader, ShapeXmlLoader, SurfaceFileLoader, VolumeFileLoader

public abstract class InterfaceShapeLoader
extends FileLoader

Abstract loader class for all loaders which load InterfaceShape objects.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Field Summary

Fields inherited from class mgui.io.FileLoader

dataFile, dataURL, options

Constructor Summary

Constructors

Constructor	Description
InterfaceShapeLoader()

Method Summary

Modifier and Type	Method	Description
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.
abstract InterfaceShape	loadShape(ShapeInputOptions options, ProgressUpdater progress_bar)	Loads a shape with the given options.

Methods inherited from class mgui.io.FileLoader

getComplementIOType, getFailureMessage, getFile, getIOType, getObjectIcon, getOptions, getProgressMessage, getSuccessMessage, getSupportedObjects, 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

Constructor Details

InterfaceShapeLoader

public InterfaceShapeLoader()

Method Details

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

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:

loadShape

public abstract InterfaceShape loadShape(ShapeInputOptions options,
ProgressUpdater progress_bar)
                                  throws java.io.IOException

Loads a shape with the given options.

Parameters:

options -

progress_bar -

Returns:

Throws:

java.io.IOException