Package mgui.io.domestic.maps

Class ColourMapLoader

java.lang.Object
mgui.io.FileLoader
mgui.io.domestic.maps.ColourMapLoader
All Implemented Interfaces:
InterfaceIO, IconObject
Direct Known Subclasses:
ContinuousColourMapLoader, DiscreteColourMapLoader
public class ColourMapLoader
extends FileLoader
Base class for loading a colour map from file. Determines whether map is continuous or discrete and loads it with the corresponding loader.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Constructor Details

    • ColourMapLoader

      public ColourMapLoader()

    • ColourMapLoader

      public ColourMapLoader​(java.io.File file)

  • 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

    • loadMap

      public ColourMap loadMap() throws java.io.IOException
      Throws:
      java.io.IOException

    • loadMap

      public ColourMap loadMap​(InterfaceIOOptions options) throws java.io.IOException
      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: