Package mgui.io.domestic.maps

Class NameMapLoader

java.lang.Object
mgui.io.FileLoader
mgui.io.domestic.maps.NameMapLoader
All Implemented Interfaces:
InterfaceIO, IconObject
public class NameMapLoader
extends FileLoader
Reads a name map from file. One of three format options are possible:
  1. Ascii - An Ascii file having two delimited columns, ordered as index (integer), then name (String)
  2. XML - An XML file comprised of entries
  3. Auto [default] - Searches for the leading xml tag; if found, reads as XML, otherwise as Ascii
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Field Details

  • Constructor Details

    • NameMapLoader

      public NameMapLoader()

    • NameMapLoader

      public NameMapLoader​(java.io.File file)

    • NameMapLoader

      public NameMapLoader​(java.io.File file, NameMapLoader.Format format)

  • 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:

    • loadNameMap

      public NameMap loadNameMap()
      Load data into name_map, with the current data format and data file
      Parameters:
      name_map -
      Returns:

    • loadNameMapAscii

      protected NameMap loadNameMapAscii​(java.lang.String[] delim)

    • loadNameMapXML

      protected NameMap loadNameMapXML()
      Loads a name map from XML format.
      Returns:

    • getObjectIcon

      public javax.swing.Icon getObjectIcon()
      Description copied from interface: IconObject
      Returns the Icon associated with this object.
      Specified by:
      getObjectIcon in interface IconObject
      Overrides:
      getObjectIcon in class FileLoader
      Returns: