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<PolygonStyle>	areaStyles
Naming	chainTypes
Script	confirmShutdownScript
Script	controlGuiScript
Script	dataFormatScript
Script	editActorScript
Naming<MapDataIndex>	findItems
java.lang.String	format
Naming	graphicGroups
Naming<ImageStyle>	imageStyles
Naming	jobTypes
java.lang.String	label
Naming<java.lang.String>	legendAliases
Naming<Legend>	legends
Naming<PolylineStyle>	lineStyles
Naming	links
Naming	locationTypes
Naming<java.util.List<java.lang.String>>	menus
java.lang.String	name
Script	noSelectionScript
java.lang.String	path
Naming<PointStyle>	pointStyles
Naming<java.lang.String>	printableStyles
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

MapEditActor	createEditActor(MapApp app)
java.io.File	fileForPath(java.lang.String subpath) Returns a File object for the given sub-path of this mapset's path.
Script	getConfirmShutdownScript() Returns the script run prior to shutdown tasks.
javax.swing.JComponent	getControlGui(MapApp app)
VfsDirectory	getDirectory()
java.lang.String	getFormat() The storage format used by this mapset for its rover data.
Naming	getGraphicGroups()
java.lang.String	getLabel()
Naming<java.lang.String>	getLegendAliases()
MapSetLogic	getLogic()
VfsFile	getManual()
Naming<java.util.List<java.lang.String>>	getMenus()
Module	getModule() The module this mapset is associated with (as named in info/module.txt).
java.lang.String	getName()
java.lang.String	getPath()
ProductBranding	getProductBranding()
VfsDirectory	getPublishedDirectory()
ScriptKeeper	getScripts() Returns the ScriptKeeper for this mapset.
Naming<java.lang.Object>	getSettings() Returns the settings from settings.xml.
Naming<java.lang.Object>	getVariables() The variables are a place to put run-time data and communicate between scripts.
java.lang.String	getVersion()
boolean	hasManual()
boolean	hasProductBranding()
void	initialize(MapApp app)
boolean	isEphemera() Returns true if this is the special Ephemera map set.
void	reload() Only called by RoverSet.reload().
java.lang.String	toString() Returns the name of the mapset.
void	translate(MapApp app, DynamicMapTranslator translator)
void	translateFromSpools(MapApp app, DynamicMapTranslator 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

label

public java.lang.String label

path

public java.lang.String path

format

public java.lang.String format

legends

public Naming<Legend> legends

legendAliases

public Naming<java.lang.String> legendAliases

menus

public Naming<java.util.List<java.lang.String>> menus

findItems

public Naming<MapDataIndex> findItems

links

public Naming links

graphicGroups

public Naming graphicGroups

areaStyles

public Naming<PolygonStyle> areaStyles

lineStyles

public Naming<PolylineStyle> lineStyles

imageStyles

public Naming<ImageStyle> imageStyles

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

translationPipelineConfig

public TranslationPipelineConfig translationPipelineConfig

dataFormatScript

public Script dataFormatScript

noSelectionScript

public Script noSelectionScript

confirmShutdownScript

public Script confirmShutdownScript

editActorScript

public Script editActorScript

controlGuiScript

public Script controlGuiScript

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

initialize

public void initialize(MapApp app)

getName

public java.lang.String getName()

getPath

public java.lang.String getPath()

getLegendAliases

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

getMenus

public Naming<java.util.List<java.lang.String>> getMenus()

getGraphicGroups

public Naming getGraphicGroups()

hasProductBranding

public boolean hasProductBranding()

getProductBranding

public ProductBranding getProductBranding()

hasManual

public boolean hasManual()

getManual

public VfsFile getManual()

getVersion

public java.lang.String getVersion()

isEphemera

public boolean isEphemera()

Returns true if this is the special Ephemera map set.

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,
                      DynamicMapTranslator translator)
               throws java.io.IOException

Throws:

java.io.IOException

translateFromSpools

public void translateFromSpools(MapApp app,
                                DynamicMapTranslator 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

fileForPath

public java.io.File fileForPath(java.lang.String subpath)

Returns a File object for the given sub-path of this mapset's path.

getDirectory

public VfsDirectory getDirectory()

createEditActor

public MapEditActor createEditActor(MapApp app)

getControlGui

public javax.swing.JComponent getControlGui(MapApp app)

getConfirmShutdownScript

public Script getConfirmShutdownScript()

Returns the script run prior to shutdown tasks. This script, if present, must return true if shutdown is OK or false if for some reason it is not. This is a good place to prompt to save files etc.

Returns:

getScripts

public ScriptKeeper getScripts()

Returns the ScriptKeeper for this mapset.

getModule

public Module getModule()

The module this mapset is associated with (as named in info/module.txt). Returns null if there is none.

getFormat

public java.lang.String getFormat()

The storage format used by this mapset for its rover data. Affects the kind of RoverSet associated with this MapSet.

getPublishedDirectory

public VfsDirectory getPublishedDirectory()

getLogic

public MapSetLogic getLogic()

getLabel

public java.lang.String getLabel()