Package ucar.unidata.gis.maps
Class MapInfo
java.lang.Object
ucar.unidata.gis.maps.MapInfo
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Xml attribute for the alignment propertystatic final String
Xml attribute for the base propertystatic final String
Xml attribute for the category propertystatic final String
Xml attribute for the color propertystatic final String
Xml attribute for the map description propertystatic final String
Xml attribute for the map description propertystatic final String
Xml attribute for the font propertystatic final String
Xml attribute for the alignment propertystatic final String
Xml attribute for the base propertystatic final String
Xml attribute for the linestyle propertystatic final String
Xml attribute for the linewidth propertystatic final String
Xml attribute for the max value propertystatic final String
Xml attribute for the min value propertystatic final String
Xml attribute for the map vertical position propertystatic final String
Xml attribute for the map source propertystatic final String
Xml attribute for the spacing propertystatic final String
Xml attribute for the sphere propertystatic final String
Xml attribute for the alignment propertystatic final String
Xml attribute for the propertystatic final String
Xml attribute for the valid property - used to ignore certain map entriesstatic final String
Xml tag for the latitude entrystatic final String
Xml tag for the latitude label entrystatic final String
Xml tag for the longitude entrystatic final String
Xml tag for the longitude entrystatic final String
Xml tag for the map entrystatic final String
Xml tag for the maps entry -
Constructor Summary
ConstructorsConstructorDescriptionMapInfo()
Parameterless ctro for unpersistenceCreate the MapInfo object with the given MapData listMapInfo
(List mapDataList, LatLonData latData, LatLonData lonData, float mapPosition) Create the MapInfo object with the given MapData list, LatLonData and map positionMapInfo
(List mapDataList, LatLonData latData, LatLonData lonData, LatLonLabelData latLabelData, LatLonLabelData lonLabelData, float mapPosition) Create the MapInfo object with the given MapData list, LatLonData and map positionCreate the MapInfo from the given xmlMapInfo
(XmlResourceCollection mapResources, boolean stopAfterFirst) Create the MapInfo from the xml files pointed to by the resource collectionMapInfo
(XmlResourceCollection mapResources, boolean stopAfterFirst, boolean stopAfterEditable) Create the MapInfo from the xml files pointed to by the resource collection -
Method Summary
Modifier and TypeMethodDescriptionstatic SampledSet
createMapData
(String source) A utility to read in the map data at the given source.boolean
Get the Flag for just loading local mapsFind and return the LatLonData object that represents the lat stateFind and return the LatLonData object that represents the lat stateGet the LatLonData property.Get the LatLonLabelData property.Find and return the LatLonData object that represents the lon stateFind and return the LatLonData object that represents the lon stateGet the MapData property.double
Get the vertical map position valuegetXml()
Return the current state (as an XML string) of this MapInfogetXml
(boolean useFullSourcePath) Get the XMLvoid
setJustLoadedLocalMaps
(boolean v) Set the Flag for just loading local mapsvoid
setLatLonData
(List value) Set the LatLonData property.void
setLatLonLabelData
(List<LatLonLabelData> value) Set the LatLonLabelData property.void
setMapDataList
(List value) Set the MapData property.void
setMapPosition
(double position) Set the map position
-
Field Details
-
TAG_LATITUDE
Xml tag for the latitude entry- See Also:
-
TAG_LONGITUDE
Xml tag for the longitude entry- See Also:
-
TAG_LATITUDELABEL
Xml tag for the latitude label entry- See Also:
-
TAG_LONGITUDELABEL
Xml tag for the longitude entry- See Also:
-
TAG_MAPS
Xml tag for the maps entry- See Also:
-
TAG_MAP
Xml tag for the map entry- See Also:
-
ATTR_COLOR
Xml attribute for the color property- See Also:
-
ATTR_FONT
Xml attribute for the font property- See Also:
-
ATTR_CATEGORY
Xml attribute for the category property- See Also:
-
ATTR_DESCRIPTION
Xml attribute for the map description property- See Also:
-
ATTR_FASTRENDER
Xml attribute for the map description property- See Also:
-
ATTR_LINEWIDTH
Xml attribute for the linewidth property- See Also:
-
ATTR_LINESTYLE
Xml attribute for the linestyle property- See Also:
-
ATTR_MINVALUE
Xml attribute for the min value property- See Also:
-
ATTR_MAXVALUE
Xml attribute for the max value property- See Also:
-
ATTR_POSITION
Xml attribute for the map vertical position property- See Also:
-
ATTR_SOURCE
Xml attribute for the map source property- See Also:
-
ATTR_SPACING
Xml attribute for the spacing property- See Also:
-
ATTR_BASE
Xml attribute for the base property- See Also:
-
ATTR_LABELLINES
Xml attribute for the base property- See Also:
-
ATTR_SPHERE
Xml attribute for the sphere property- See Also:
-
ATTR_ALIGNMENT
Xml attribute for the alignment property- See Also:
-
ATTR_LABELFORMAT
Xml attribute for the alignment property- See Also:
-
ATTR_USE360
Xml attribute for the alignment property- See Also:
-
ATTR_VALID
Xml attribute for the property- See Also:
-
ATTR_VISIBLE
Xml attribute for the valid property - used to ignore certain map entries- See Also:
-
-
Constructor Details
-
MapInfo
public MapInfo()Parameterless ctro for unpersistence -
MapInfo
Create the MapInfo object with the given MapData list- Parameters:
mapDataList
- List of MapData
-
MapInfo
Create the MapInfo object with the given MapData list, LatLonData and map position- Parameters:
mapDataList
- List of MapDatalatData
- The lat datalonData
- The lon datamapPosition
- The map position
-
MapInfo
public MapInfo(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 MapDatalatData
- The lat datalonData
- The lon datalatLabelData
- The lat label datalonLabelData
- The lon label datamapPosition
- The map position
-
MapInfo
Create the MapInfo from the given xml- Parameters:
root
- The xml
-
MapInfo
Create the MapInfo from the xml files pointed to by the resource collection- Parameters:
mapResources
- Xml resourcesstopAfterFirst
- 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 resourcesstopAfterFirst
- If true then stop after we have loaded an editable resourcestopAfterEditable
- If we encounter any local maps.xml file then load it in and quit the loop
-
-
Method Details
-
getXml
Return the current state (as an XML string) of this MapInfo- Returns:
- The xml representation of the current state
-
getXml
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
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
Set the LatLonData property.- Parameters:
value
- The new value for LatLonData
-
getLatLonData
Get the LatLonData property.- Returns:
- The LatLonData
-
setLatLonLabelData
Set the LatLonLabelData property.- Parameters:
value
- The new value for LatLonData
-
getLatLonLabelData
Get the LatLonLabelData property.- Returns:
- The LatLonLabelData
-
setMapDataList
Set the MapData property.- Parameters:
value
- The new value for MapData
-
getMapDataList
Get the MapData property.- Returns:
- The MapData
-
getLatData
Find and return the LatLonData object that represents the lat state- Returns:
- The lat state
-
getLonData
Find and return the LatLonData object that represents the lon state- Returns:
- The lon state
-
getLatLabelData
Find and return the LatLonData object that represents the lat state- Returns:
- The lat state
-
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
-