MapInfo (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.gis.maps.MapInfo

public class MapInfo
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTR_ALIGNMENT` Xml attribute for the alignment property
`static java.lang.String`	`ATTR_BASE` Xml attribute for the base property
`static java.lang.String`	`ATTR_CATEGORY` Xml attribute for the category property
`static java.lang.String`	`ATTR_COLOR` Xml attribute for the color property
`static java.lang.String`	`ATTR_DESCRIPTION` Xml attribute for the map description property
`static java.lang.String`	`ATTR_FASTRENDER` Xml attribute for the map description property
`static java.lang.String`	`ATTR_FONT` Xml attribute for the font property
`static java.lang.String`	`ATTR_LABELFORMAT` Xml attribute for the alignment property
`static java.lang.String`	`ATTR_LABELLINES` Xml attribute for the base property
`static java.lang.String`	`ATTR_LINESTYLE` Xml attribute for the linestyle property
`static java.lang.String`	`ATTR_LINEWIDTH` Xml attribute for the linewidth property
`static java.lang.String`	`ATTR_MAXVALUE` Xml attribute for the max value property
`static java.lang.String`	`ATTR_MINVALUE` Xml attribute for the min value property
`static java.lang.String`	`ATTR_POSITION` Xml attribute for the map vertical position property
`static java.lang.String`	`ATTR_SOURCE` Xml attribute for the map source property
`static java.lang.String`	`ATTR_SPACING` Xml attribute for the spacing property
`static java.lang.String`	`ATTR_SPHERE` Xml attribute for the sphere property
`static java.lang.String`	`ATTR_USE360` Xml attribute for the alignment property
`static java.lang.String`	`ATTR_VALID` Xml attribute for the property
`static java.lang.String`	`ATTR_VISIBLE` Xml attribute for the valid property - used to ignore certain map entries
`static java.lang.String`	`TAG_LATITUDE` Xml tag for the latitude entry
`static java.lang.String`	`TAG_LATITUDELABEL` Xml tag for the latitude label entry
`static java.lang.String`	`TAG_LONGITUDE` Xml tag for the longitude entry
`static java.lang.String`	`TAG_LONGITUDELABEL` Xml tag for the longitude entry
`static java.lang.String`	`TAG_MAP` Xml tag for the map entry
`static java.lang.String`	`TAG_MAPS` Xml tag for the maps entry

Constructor Summary

Constructors
Constructor and Description
`MapInfo()` Parameterless ctro for unpersistence
`MapInfo(org.w3c.dom.Element root)` Create the MapInfo from the given xml
`MapInfo(java.util.List mapDataList)` Create the MapInfo object with the given MapData list
`MapInfo(java.util.List mapDataList, LatLonData latData, LatLonData lonData, float mapPosition)` Create the MapInfo object with the given MapData list, LatLonData and map position
`MapInfo(java.util.List mapDataList, LatLonData latData, LatLonData lonData, LatLonLabelData latLabelData, LatLonLabelData lonLabelData, float mapPosition)` Create the MapInfo object with the given MapData list, LatLonData and map position
`MapInfo(XmlResourceCollection mapResources, boolean stopAfterFirst)` Create the MapInfo from the xml files pointed to by the resource collection
`MapInfo(XmlResourceCollection mapResources, boolean stopAfterFirst, boolean stopAfterEditable)` Create the MapInfo from the xml files pointed to by the resource collection

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static visad.SampledSet`	`createMapData(java.lang.String source)` A utility to read in the map data at the given source.
`boolean`	`getJustLoadedLocalMaps()` Get the Flag for just loading local maps
`LatLonData`	`getLatData()` Find and return the LatLonData object that represents the lat state
`LatLonLabelData`	`getLatLabelData()` Find and return the LatLonData object that represents the lat state
`java.util.List`	`getLatLonData()` Get the LatLonData property.
`java.util.List<LatLonLabelData>`	`getLatLonLabelData()` Get the LatLonLabelData property.
`LatLonData`	`getLonData()` Find and return the LatLonData object that represents the lon state
`LatLonLabelData`	`getLonLabelData()` Find and return the LatLonData object that represents the lon state
`java.util.List<MapData>`	`getMapDataList()` Get the MapData property.
`double`	`getMapPosition()` Get the vertical map position value
`java.lang.String`	`getXml()` Return the current state (as an XML string) of this MapInfo
`java.lang.String`	`getXml(boolean useFullSourcePath)` Get the XML
`void`	`setJustLoadedLocalMaps(boolean v)` Set the Flag for just loading local maps
`void`	`setLatLonData(java.util.List value)` Set the LatLonData property.
`void`	`setLatLonLabelData(java.util.List<LatLonLabelData> value)` Set the LatLonLabelData property.
`void`	`setMapDataList(java.util.List value)` Set the MapData property.
`void`	`setMapPosition(double position)` Set the map position

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TAG_LATITUDE
```
public static final java.lang.String TAG_LATITUDE
```
    Xml tag for the latitude entry
    
    See Also:
    
    Constant Field Values
  - TAG_LONGITUDE
```
public static final java.lang.String TAG_LONGITUDE
```
    Xml tag for the longitude entry
    
    See Also:
    
    Constant Field Values
  - TAG_LATITUDELABEL
```
public static final java.lang.String TAG_LATITUDELABEL
```
    Xml tag for the latitude label entry
    
    See Also:
    
    Constant Field Values
  - TAG_LONGITUDELABEL
```
public static final java.lang.String TAG_LONGITUDELABEL
```
    Xml tag for the longitude entry
    
    See Also:
    
    Constant Field Values
  - TAG_MAPS
```
public static final java.lang.String TAG_MAPS
```
    Xml tag for the maps entry
    
    See Also:
    
    Constant Field Values
  - TAG_MAP
```
public static final java.lang.String TAG_MAP
```
    Xml tag for the map entry
    
    See Also:
    
    Constant Field Values
  - ATTR_COLOR
```
public static final java.lang.String ATTR_COLOR
```
    Xml attribute for the color property
    
    See Also:
    
    Constant Field Values
  - ATTR_FONT
```
public static final java.lang.String ATTR_FONT
```
    Xml attribute for the font property
    
    See Also:
    
    Constant Field Values
  - ATTR_CATEGORY
```
public static final java.lang.String ATTR_CATEGORY
```
    Xml attribute for the category property
    
    See Also:
    
    Constant Field Values
  - ATTR_DESCRIPTION
```
public static final java.lang.String ATTR_DESCRIPTION
```
    Xml attribute for the map description property
    
    See Also:
    
    Constant Field Values
  - ATTR_FASTRENDER
```
public static final java.lang.String ATTR_FASTRENDER
```
    Xml attribute for the map description property
    
    See Also:
    
    Constant Field Values
  - ATTR_LINEWIDTH
```
public static final java.lang.String ATTR_LINEWIDTH
```
    Xml attribute for the linewidth property
    
    See Also:
    
    Constant Field Values
  - ATTR_LINESTYLE
```
public static final java.lang.String ATTR_LINESTYLE
```
    Xml attribute for the linestyle property
    
    See Also:
    
    Constant Field Values
  - ATTR_MINVALUE
```
public static final java.lang.String ATTR_MINVALUE
```
    Xml attribute for the min value property
    
    See Also:
    
    Constant Field Values
  - ATTR_MAXVALUE
```
public static final java.lang.String ATTR_MAXVALUE
```
    Xml attribute for the max value property
    
    See Also:
    
    Constant Field Values
  - ATTR_POSITION
```
public static final java.lang.String ATTR_POSITION
```
    Xml attribute for the map vertical position property
    
    See Also:
    
    Constant Field Values
  - ATTR_SOURCE
```
public static final java.lang.String ATTR_SOURCE
```
    Xml attribute for the map source property
    
    See Also:
    
    Constant Field Values
  - ATTR_SPACING
```
public static final java.lang.String ATTR_SPACING
```
    Xml attribute for the spacing property
    
    See Also:
    
    Constant Field Values
  - ATTR_BASE
```
public static final java.lang.String ATTR_BASE
```
    Xml attribute for the base property
    
    See Also:
    
    Constant Field Values
  - ATTR_LABELLINES
```
public static final java.lang.String ATTR_LABELLINES
```
    Xml attribute for the base property
    
    See Also:
    
    Constant Field Values
  - ATTR_SPHERE
```
public static final java.lang.String ATTR_SPHERE
```
    Xml attribute for the sphere property
    
    See Also:
    
    Constant Field Values
  - ATTR_ALIGNMENT
```
public static final java.lang.String ATTR_ALIGNMENT
```
    Xml attribute for the alignment property
    
    See Also:
    
    Constant Field Values
  - ATTR_LABELFORMAT
```
public static final java.lang.String ATTR_LABELFORMAT
```
    Xml attribute for the alignment property
    
    See Also:
    
    Constant Field Values
  - ATTR_USE360
```
public static final java.lang.String ATTR_USE360
```
    Xml attribute for the alignment property
    
    See Also:
    
    Constant Field Values
  - ATTR_VALID
```
public static final java.lang.String ATTR_VALID
```
    Xml attribute for the property
    
    See Also:
    
    Constant Field Values
  - ATTR_VISIBLE
```
public static final java.lang.String ATTR_VISIBLE
```
    Xml attribute for the valid property - used to ignore certain map entries
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MapInfo
```
public MapInfo()
```
    Parameterless ctro for unpersistence
  - MapInfo
```
public MapInfo(java.util.List mapDataList)
```
    Create the MapInfo object with the given MapData list
    
    Parameters:
    
    mapDataList - List of MapData
  - MapInfo
```
public MapInfo(java.util.List mapDataList,
               LatLonData latData,
               LatLonData lonData,
               float mapPosition)
```
    Create the MapInfo object with the given MapData list, LatLonData and map position
    
    Parameters:
    
    mapDataList - List of MapData
    
    latData - The lat data
    
    lonData - The lon data
    
    mapPosition - The map position
  - MapInfo
```
public MapInfo(java.util.List mapDataList,
               LatLonData latData,
               LatLonData lonData,
               LatLonLabelData latLabelData,
               LatLonLabelData lonLabelData,
               float mapPosition)
```
    Create the MapInfo object with the given MapData list, LatLonData and map position
    
    Parameters:
    
    mapDataList - List of MapData
    
    latData - The lat data
    
    lonData - The lon data
    
    latLabelData - The lat label data
    
    lonLabelData - The lon label data
    
    mapPosition - The map position
  - MapInfo
```
public MapInfo(org.w3c.dom.Element root)
```
    Create the MapInfo from the given xml
    
    Parameters:
    
    root - The xml
  - MapInfo
```
public MapInfo(XmlResourceCollection mapResources,
               boolean stopAfterFirst)
```
    Create the MapInfo from the xml files pointed to by the resource collection
    
    Parameters:
    
    mapResources - Xml resources
    
    stopAfterFirst - Stop loading in maps after the first
  - MapInfo
```
public MapInfo(XmlResourceCollection mapResources,
               boolean stopAfterFirst,
               boolean stopAfterEditable)
```
    Create the MapInfo from the xml files pointed to by the resource collection
    
    Parameters:
    
    mapResources - Xml resources
    
    stopAfterFirst - If true then stop after we have loaded an editable resource
    
    stopAfterEditable - If we encounter any local maps.xml file then load it in and quit the loop
- Method Detail
  - getXml
```
public java.lang.String getXml()
```
    Return the current state (as an XML string) of this MapInfo
    
    Returns:
    
    The xml representation of the current state
  - getXml
```
public java.lang.String getXml(boolean useFullSourcePath)
```
    Get the XML
    
    Parameters:
    
    useFullSourcePath - true to use the full source path
    
    Returns:
    
    the Xml
  - getMapPosition
```
public double getMapPosition()
```
    Get the vertical map position value
    
    Returns:
    
    map position value
  - setMapPosition
```
public void setMapPosition(double position)
```
    Set the map position
    
    Parameters:
    
    position - The position
  - createMapData
```
public static visad.SampledSet createMapData(java.lang.String source)
```
    A utility to read in the map data at the given source.
    
    Parameters:
    
    source - The fil, url or java resource to a map file (mcidas or shp)
    
    Returns:
    
    The data or null if this fails.
  - setLatLonData
```
public void setLatLonData(java.util.List value)
```
    Set the LatLonData property.
    
    Parameters:
    
    value - The new value for LatLonData
  - getLatLonData
```
public java.util.List getLatLonData()
```
    Get the LatLonData property.
    
    Returns:
    
    The LatLonData
  - setLatLonLabelData
```
public void setLatLonLabelData(java.util.List<LatLonLabelData> value)
```
    Set the LatLonLabelData property.
    
    Parameters:
    
    value - The new value for LatLonData
  - getLatLonLabelData
```
public java.util.List<LatLonLabelData> getLatLonLabelData()
```
    Get the LatLonLabelData property.
    
    Returns:
    
    The LatLonLabelData
  - setMapDataList
```
public void setMapDataList(java.util.List value)
```
    Set the MapData property.
    
    Parameters:
    
    value - The new value for MapData
  - getMapDataList
```
public java.util.List<MapData> getMapDataList()
```
    Get the MapData property.
    
    Returns:
    
    The MapData
  - getLatData
```
public LatLonData getLatData()
```
    Find and return the LatLonData object that represents the lat state
    
    Returns:
    
    The lat state
  - getLonData
```
public LatLonData getLonData()
```
    Find and return the LatLonData object that represents the lon state
    
    Returns:
    
    The lon state
  - getLatLabelData
```
public LatLonLabelData getLatLabelData()
```
    Find and return the LatLonData object that represents the lat state
    
    Returns:
    
    The lat state
  - getLonLabelData
```
public LatLonLabelData getLonLabelData()
```
    Find and return the LatLonData object that represents the lon state
    
    Returns:
    
    The lon state
  - getJustLoadedLocalMaps
```
public boolean getJustLoadedLocalMaps()
```
    Get the Flag for just loading local maps
    
    Returns:
    
    the flag
  - setJustLoadedLocalMaps
```
public void setJustLoadedLocalMaps(boolean v)
```
    Set the Flag for just loading local maps
    
    Parameters:
    
    v - the flag

Class MapInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG_LATITUDE

TAG_LONGITUDE

TAG_LATITUDELABEL

TAG_LONGITUDELABEL

TAG_MAPS

TAG_MAP

ATTR_COLOR

ATTR_FONT

ATTR_CATEGORY

ATTR_DESCRIPTION

ATTR_FASTRENDER

ATTR_LINEWIDTH

ATTR_LINESTYLE

ATTR_MINVALUE

ATTR_MAXVALUE

ATTR_POSITION

ATTR_SOURCE

ATTR_SPACING

ATTR_BASE

ATTR_LABELLINES

ATTR_SPHERE

ATTR_ALIGNMENT

ATTR_LABELFORMAT

ATTR_USE360

ATTR_VALID

ATTR_VISIBLE

Constructor Detail

MapInfo

MapInfo

MapInfo

MapInfo

MapInfo

MapInfo

MapInfo

Method Detail

getXml

getXml

getMapPosition

setMapPosition

createMapData

setLatLonData

getLatLonData

setLatLonLabelData

getLatLonLabelData

setMapDataList

getMapDataList

getLatData

getLonData

getLatLabelData

getLonLabelData

getJustLoadedLocalMaps

setJustLoadedLocalMaps