Package hec.map

Class MapIdentifier

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.io.Identifier
hec.map.MapIdentifier
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable
public class MapIdentifier extends Identifier implements Serializable
Provides a description of a Map and its characteristics.
See Also:

  • Field Details

    • m_maximumScale

      protected int m_maximumScale
      This provides the upper scale limit that this map will be valid.

    • m_minimumScale

      protected int m_minimumScale
      This provides the lower scale limit that this map will be valid.

    • m_modifiedTime

      protected long m_modifiedTime
      Last time the map was added, for caching

    • _mapShown

      protected boolean _mapShown
      The if the map is shown

    • _glyphDataRec

      protected GlyphDataRecord _glyphDataRec
      The Display Characteristics for the Map

    • _stringClass

      protected String _stringClass
      The class of the Map

    • _isManager

      protected boolean _isManager
      whether this map represents a manager

    • _isBackground

      protected boolean _isBackground
      whether this map represents a background

    • _isDefaultMap

      protected boolean _isDefaultMap
      whether this map should be shown automatically in all MapPanels

  • Constructor Details

    • MapIdentifier

      public MapIdentifier()
      The default constructor.

    • MapIdentifier

      public MapIdentifier(String path, HecFile file)
      Create a new MapIdentifier using the default constructor. Set the MapIdentifier's path String to the path String argument. Set the MapIdentifier's HecFile to the HecFile argument.

    • MapIdentifier

      public MapIdentifier(String path)
      Create a new MapIdentifier using the default constructor. Set the MapIdentifier's path String to the path String argument.

    • MapIdentifier

      public MapIdentifier(Identifier id)
      Create a new MapIdentifier using the default constructor. Set the MapIdentifier's superclass data members to the argument Identifier's values using super(Identifier).

    • MapIdentifier

      public MapIdentifier(MapIdentifier id)

  • Method Details

    • setIdentifier

      public void setIdentifier(Identifier id)
      Change the Identifier characteristics of the MapIdentifier. This is used for where the MapIdentifier is identifying a map, but the underlying file for the map is being changed. Example, a DLGMap starts off as "map.dlg". Once it is loaded once, the binary version is created as "map.dlgbin". From then on the binary version should be loaded for speed. Therefore the MapIdentifiers underlying File attributes are changed using setIdentifer().
      setIdentifier() set's the String path, Class, directory flag, and HecFile of the MapIdentifier. It keeps the name, description, and all MapIdentifier data members.

    • setIdentifier

      public void setIdentifier(MapIdentifier id)

    • getMaximumScale

      public int getMaximumScale()

    • getMinimumScale

      public int getMinimumScale()

    • setMaximumScale

      public void setMaximumScale(int maxScale)

    • setMinimumScale

      public void setMinimumScale(int minScale)

    • setModifiedTime

      public void setModifiedTime(long modifiedTime)

    • getModifiedTime

      public long getModifiedTime()

    • setMapShown

      public void setMapShown(boolean tf)
      Set the default state of whether or not the map is shown.

    • getMapShown

      public boolean getMapShown()
      get the default state of whether or not the map is shown.
      Returns:
      the default shown state

    • setMapShown

      public void setMapShown(boolean shown, MapGlyph glyph)
      Set whether or not the map is shown.

    • getMapShown

      public boolean getMapShown(MapGlyph glyph)
      Get whether or not the map is shown.

    • getGlyphDataRecord

      public GlyphDataRecord getGlyphDataRecord()
      Get the Glyph characteritics object.

    • setGlyphDataRecord

      public void setGlyphDataRecord(GlyphDataRecord rec)
      Set the Glyph characteritics object.

    • setClassName

      public void setClassName(String str)
      Set the class name of the Map.
      Overrides:
      setClassName in class Identifier

    • getClassName

      public String getClassName()
      Get the class name of the Map.
      Overrides:
      getClassName in class Identifier

    • setIsManager

      public void setIsManager(boolean b)
      set whether this mapId represents a manager

    • isManager

      public boolean isManager()
      get whether this mapId represents a manager

    • setIsBackground

      public void setIsBackground(boolean b)
      set whether this mapId represents a background

    • isBackground

      public boolean isBackground()
      get whether this mapId represents a background

    • isMap

      public boolean isMap()

    • isDefaultMap

      public boolean isDefaultMap()
      Returns:
      whether this map should be shown automatically in all MapPanels

    • setDefaultMap

      public void setDefaultMap(boolean defaultMap)
      set whether this map should be shown automatically in all MapPanels
      Parameters:
      defaultMap - true to have this map added to all MapPanels

    • clearGlyphShownFlags

      public void clearGlyphShownFlags()