Package mgui.io.foreign.caret

Class CaretMetricLoader

java.lang.Object

mgui.io.FileLoader

mgui.io.domestic.shapes.SurfaceDataFileLoader

mgui.io.foreign.caret.CaretMetricLoader

All Implemented Interfaces:

InterfaceIO, IconObject

public class CaretMetricLoader
extends SurfaceDataFileLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CaretMetricLoader.Header

Field Summary

Fields inherited from class mgui.io.FileLoader

dataFile, dataURL, options

Constructor Summary

Constructors

Constructor	Description
CaretMetricLoader()
CaretMetricLoader(java.io.File file)

Method Summary

Modifier and Type	Method	Description
CaretMetricLoader.Header	getHeader()
boolean	load(InterfaceIOOptions options, ProgressUpdater progress_bar)	Loads data from the set of files or URLs specified by options.
java.util.ArrayList<java.util.ArrayList<MguiNumber>>	loadAllValues()
java.util.ArrayList<java.util.ArrayList<MguiNumber>>	loadAllValues(ProgressUpdater progress_bar)
protected void	loadHeader()
java.lang.Object	loadObject(ProgressUpdater progress_bar, InterfaceIOOptions options)	Loads data into an instance of the object corresponding to this loader.
java.util.ArrayList<MguiNumber>	loadValues(ProgressUpdater progress_bar)

Methods inherited from class mgui.io.domestic.shapes.SurfaceDataFileLoader

getFailureMessage, getObjectIcon, getSuccessMessage, getSupportedObjects, getTitle, loadValues

Methods inherited from class mgui.io.FileLoader

getComplementIOType, getFile, getIOType, getOptions, getProgressMessage, 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

CaretMetricLoader

public CaretMetricLoader()

CaretMetricLoader

public CaretMetricLoader(java.io.File file)

Method Details

getHeader

public CaretMetricLoader.Header getHeader()

loadHeader

protected void loadHeader()

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 SurfaceDataFileLoader

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.

Overrides:

load in class SurfaceDataFileLoader

progress_bar - An optional progress updater. Can be null.

Returns:

loadValues

public java.util.ArrayList<MguiNumber> loadValues(ProgressUpdater progress_bar)

Specified by:

loadValues in class SurfaceDataFileLoader

loadAllValues

public java.util.ArrayList<java.util.ArrayList<MguiNumber>> loadAllValues()

loadAllValues

public java.util.ArrayList<java.util.ArrayList<MguiNumber>> loadAllValues(ProgressUpdater progress_bar)