com.partnersoft.maps.model
Class MapSet

java.lang.Object
  com.partnersoft.maps.model.MapSet

public class MapSet
extends java.lang.Object

A MapSet represents a set of map data in the same coordinate system that is suitable for viewing as a single map. It consists of a set of MapDataSets, each with its own legends, datatypes, and graphic types.

Author:

Paul Reavis Copyright 2003 Partner Software, Inc.

Field Summary

Naming<Script>	actions
Naming<PolygonStyle>	areaStyles
Naming	chainTypes
CogDataDictionary	dataDictionary
Script	dataFormatScript
Naming<Script>	drawingScripts
Naming<MapDataIndex>	findItems
Naming<Script>	frontends
Naming	graphicGroups
Naming	jobTypes
Naming<java.lang.String>	legendAliases
Naming<Legend>	legends
Naming<PolylineStyle>	lineStyles
Naming	links
Naming	locationTypes
java.lang.String	name
java.lang.String	path
Naming<PointStyle>	pointStyles
Naming<java.lang.String>	printableStyles
Naming<Script>	scripts
Naming<Script>	startups
Naming<TextStyle>	textStyles
TranslationPipelineConfig	translationPipelineConfig

Constructor Summary

MapSet(java.lang.String name)
Builds and loads itself based on the given name.

MapSet(java.lang.String name, java.lang.String path)

Method Summary

Naming<Script>	getActions()
Naming<Script>	getDrawingScripts()
Naming	getGraphicGroups()
Naming<java.lang.String>	getLegendAliases()
java.lang.String	getName()
java.lang.String	getPath()
ProductBranding	getProductBranding()
Naming<java.lang.Object>	getSettings() Returns the settings from settings.xml.
Naming<Script>	getStartups()
Naming<java.lang.Object>	getVariables() The variables are a place to put run-time data and communicate between scripts.
void	reload() Only called by RoverSet.reload().
java.lang.String	toString() Returns the name of the mapset.
void	translate(MapApp app, OpsTranslator translator)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

path

public java.lang.String path

legends

public Naming<Legend> legends

legendAliases

public Naming<java.lang.String> legendAliases

actions

public Naming<Script> actions

findItems

public Naming<MapDataIndex> findItems

links

public Naming links

frontends

public Naming<Script> frontends

startups

public Naming<Script> startups

graphicGroups

public Naming graphicGroups

scripts

public Naming<Script> scripts

drawingScripts

public Naming<Script> drawingScripts

areaStyles

public Naming<PolygonStyle> areaStyles

lineStyles

public Naming<PolylineStyle> lineStyles

pointStyles

public Naming<PointStyle> pointStyles

textStyles

public Naming<TextStyle> textStyles

printableStyles

public Naming<java.lang.String> printableStyles

jobTypes

public Naming jobTypes

chainTypes

public Naming chainTypes

locationTypes

public Naming locationTypes

dataDictionary

public CogDataDictionary dataDictionary

translationPipelineConfig

public TranslationPipelineConfig translationPipelineConfig

dataFormatScript

public Script dataFormatScript

Constructor Detail

MapSet

public MapSet(java.lang.String name)
       throws java.io.IOException

Builds and loads itself based on the given name.

Throws:

java.io.IOException

MapSet

public MapSet(java.lang.String name,
              java.lang.String path)
       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

getPath

public java.lang.String getPath()

getLegendAliases

public Naming<java.lang.String> getLegendAliases()

getActions

public Naming<Script> getActions()

getStartups

public Naming<Script> getStartups()

getDrawingScripts

public Naming<Script> getDrawingScripts()

getGraphicGroups

public Naming getGraphicGroups()

getProductBranding

public ProductBranding getProductBranding()

getSettings

public Naming<java.lang.Object> getSettings()

Returns the settings from settings.xml. Automatically reloads them if the file was changed.

translate

public void translate(MapApp app,
                      OpsTranslator translator)
               throws java.io.IOException

Throws:

java.io.IOException

getVariables

public Naming<java.lang.Object> getVariables()

The variables are a place to put run-time data and communicate between scripts. This is safer than using the app.logic.variables, since they will be mapset-specific and you won't have crosstalk between two mapsets (e.g. if you copy and rename one to play with it, but still use the same variables).

reload

public void reload()
            throws java.io.IOException

Only called by RoverSet.reload().

Throws:

java.io.IOException

toString

public java.lang.String toString()

Returns the name of the mapset.

Overrides:

toString in class java.lang.Object