com.moximedia.aims
Class AimsWebSiteConfig

java.lang.Object
  com.moximedia.aims.AimsWebSiteConfig

All Implemented Interfaces:

java.io.Serializable

public class AimsWebSiteConfig

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

AimsWebSiteConfig()
Creates new WebSiteConfiguration

Method Summary

void	addIdentifyReportCoordinateProjection(AimsProjection projection)
void	addMapScript(java.lang.String scriptName) Adds a map script to the map script array.
void	addMxdTemplate(AimsMxdTemplate template) Adds an MXD template to support plotting using other services.
void	addQuickViewExtent(AimsEnvelope namedExtent) Adds a named envelope to the quickview extents shown on the status bar.
void	addStartupScript(java.lang.String scriptName)
void	addToolset(AimsWebSiteToolset toolset)
boolean	applyXmlThemes(java.lang.String themeURL)
void	clearIdentifyReportCoordinateProjections()
java.lang.String	getActiveToolName()
AimsWebSiteToolset	getActiveToolset()
boolean	getAutoRefresh() Gets an indicator of whether the map autorefreshes.
AimsColor	getBackgroundColor()
java.lang.String	getBrowser()
AimsProjection	getCenterCoordinateProjection()
java.lang.String	getCoordinateScript()
int	getCoordinateSystemZone()
java.lang.String	getDataFramePosition()
java.lang.String	getDataFrameUrl()
int	getDataFrameWidth()
java.lang.String	getEditToolsXmlUrl()
AimsWebSiteFindLocationType	getFindLocationType(java.lang.String type)
AimsWebSiteFindLocationTypes	getFindLocationTypes()
java.lang.String	getFrameworkUrlPath()
AimsEnvelope	getFullExtent()
java.lang.String	getHiddenFrameUrl()
int	getHiddenFrameWidth()
AimsProjection[]	getIdentifyReportCoordinateProjections()
java.lang.String	getImfPropertiesFileName() Gets the properties file name used for IMF settings.
java.lang.String	getIndexMapDataFrame()
java.lang.String	getIndexMapScriptName()
java.lang.String	getIndexMapScriptUrl() Gets the url of the index map script.
java.lang.String	getIndexMapServer()
java.lang.String	getIndexMapService()
java.lang.String	getIndexMapServlet()
AimsEnvelope	getInitialExtent()
boolean	getLayerManagerLayersVisible() Reports whether layers will be visible when added using the layer manager.
java.lang.String	getLayersScriptName()
java.lang.String	getLayersScriptUrl() Gets the url of the legend script.
java.lang.String	getLayersXmlUrl()
java.lang.String	getLegendScriptName()
java.lang.String	getLegendScriptUrl() Gets the url of the legend script.
java.lang.String	getMapCopyrightText()
java.lang.String	getMapDataframe()
java.lang.String	getMapDataFrame()
java.lang.String	getMapFrameUrl()
java.lang.String	getMapLogoUrl()
java.util.ArrayList	getMapScripts() Gets the map script array, or null if there are not any.
java.lang.String	getMapServer()
java.lang.String	getMapService()
java.lang.String	getMapServlet()
AimsEnvelope	getMaximumExtent()
java.lang.Integer	getMaximumLayerManagerLayers() Reports the maximum number of visible layers that can be shown using the layer manager.
double	getMaximumScale()
double	getMinimumScale()
AimsMxdTemplate	getMxdTemplate(java.lang.String name) Gets the MXD template with the specified name, or null.
java.util.ArrayList	getMxdTemplates() Gets an ArrayList of templates, or null.
double	getNorthArrowMaxScale() Gets the maximum scale that the north arrow is shown.
int	getNorthArrowSize() Gets the size of the north arrow.
AimsColor	getPanBorderOutColor()
AimsColor	getPanBorderOverColor()
boolean	getPrintMapLegend() Gets a boolean indicator of whether to include the legend on the printed map.
Templates	getPrintTemplates()
java.lang.String	getPrintXmlUrl()
AimsProjection	getProjection()
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <property> element.
java.util.ArrayList	getQuickViewExtents() Gets the array of quickview extents, or null if no quickview extents exist.
AimsRegistrations	getRegistrations()
java.lang.String	getScalebarUnits()
AimsWebSiteSelectMenuOptions	getSelectMenuOptions()
boolean	getShowAutoRefresh() Gets an indicator of whether the map autorefresh message should display.
java.lang.String	getSiteUrl()
java.lang.String	getSiteUrlPath()
java.util.ArrayList	getStartupScripts()
int	getStatusFrameHeight()
java.lang.String	getStatusFrameUrl()
java.lang.String	getStatusScriptUrl() Gets the url of the status script.
int	getTabDecorationLeftHeight()
java.lang.String	getTabDecorationLeftUrl()
int	getTabDecorationLeftWidth()
int	getTabDecorationRightHeight()
java.lang.String	getTabDecorationRightUrl()
int	getTabDecorationRightWidth()
int	getTabDecorationSpaceHeight()
java.lang.String	getTabDecorationSpaceUrl()
int	getTabDecorationSpaceWidth()
java.lang.String	getTabFrameUrl()
java.util.Vector	getTabs()
java.util.Vector	getThemes()
java.lang.String	getThemesXmlUrl()
java.lang.String	getThemeUrlPath()
int	getTitleFrameHeight()
java.lang.String	getTitleFrameUrl()
AimsWebSiteTool	getTool(java.lang.String toolName)
AimsWebSiteTool[]	getToolArray()
int	getToolFrameHeight()
java.lang.String	getToolFrameUrl()
java.lang.String	getToolPosition()
java.util.Vector	getTools()
AimsWebSiteToolset	getToolset(java.lang.String toolsetName)
java.util.ArrayList	getToolsets()
java.lang.String	getWebmasterEmailAddress()
java.lang.String	getWebmasterEmailSubject()
java.lang.String	getWindowTitle()
boolean	hasMxdTemplates() Returns an indicator of whether there are any MXD templates.
boolean	isBackgroundTransparent()
void	removeProperty(java.lang.String name) Removes the specified property.
void	removeQuickViewExtent(java.lang.String name) Removes a named envelope from the quickview extents shown on the status bar.
void	setActiveToolset(java.lang.String toolsetName)
void	setAutoRefresh(boolean autoRefresh) Sets whether the map autorefreshes.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
protected void	setBackgroundColor(AimsColor color)
void	setBrowser(java.lang.String browser)
void	setCenterCoordinateProjection(AimsProjection projection)
void	setCoordinateScript(java.lang.String url)
void	setCoordinateSystemZone(int zone)
void	setEditToolsXmlUrl(java.lang.String editToolsXmlUrl)
void	setFrameworkUrlPath(java.lang.String path)
void	setFullExtent(AimsEnvelope env)
void	setHiddenFrameUrl(java.lang.String url)
void	setImfPropertiesFileName(java.lang.String name) Sets the properties file name used for IMF settings.
void	setIndexMapServer(java.lang.String mapServer)
void	setIndexMapService(java.lang.String mapService)
void	setIndexMapServlet(java.lang.String indexMapServlet)
void	setInitialExtent(AimsEnvelope env)
void	setLayerManagerLayersVisible(boolean flag) Sets whether layers will be visible when added using the layer manager.
void	setLayersXmlUrl(java.lang.String layersXmlUrl)
void	setMapDataframe(java.lang.String mapDataframe)
void	setMapServer(java.lang.String mapServer)
void	setMapService(java.lang.String mapService)
void	setMapServlet(java.lang.String mapServlet)
void	setMaximumExtent(AimsEnvelope env)
void	setMaximumLayerManagerLayers(int count) Sets the maximum number of visible layers that can be shown using the layer manager.
void	setPrintMapLegend(boolean printLegend) Sets whether to include the legend on the printed map.
void	setPrintXmlUrl(java.lang.String url)
void	setProjection(AimsProjection projection)
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setScalebarUnits(java.lang.String units)
void	setShowAutoRefresh(boolean showAutoRefresh) Sets whether the map autorefresh message should display.
void	setSiteUrl(java.lang.String href)
void	setSiteUrlPath(java.lang.String path)
void	setStatusFrameUrl(java.lang.String url)
void	setThemesXmlUrl(java.lang.String themesXmlUrl)
void	setThemeUrlPath(java.lang.String path)
void	setTitleFrameUrl(java.lang.String url)
void	setToolFrameHeight(int height)
void	setToolFrameUrl(java.lang.String url)
boolean	showBrowserToolbar()
boolean	showLayerListLegends()
void	showLayerListLegends(boolean show)
boolean	showNorthArrow()
boolean	showPanBorder()
boolean	showScalebar() Returns a value indicating if the scalebar is to be shown.
boolean	showVersion() Gets whether the version number should be displayed on the layers page.
boolean	usesLayerManager()

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsWebSiteConfig

public AimsWebSiteConfig()

Creates new WebSiteConfiguration

Method Detail

getRegistrations

public AimsRegistrations getRegistrations()

getImfPropertiesFileName

public java.lang.String getImfPropertiesFileName()

Gets the properties file name used for IMF settings.

Returns:

The name of the properties file.

setImfPropertiesFileName

public void setImfPropertiesFileName(java.lang.String name)

Sets the properties file name used for IMF settings.

Parameters:

name - The name of the properties file.

addQuickViewExtent

public void addQuickViewExtent(AimsEnvelope namedExtent)

Adds a named envelope to the quickview extents shown on the status bar. The quickview extents can be set using the quick-view element in the site configuration XML file.

Parameters:

namedExtent - An envelope with a name.

removeQuickViewExtent

public void removeQuickViewExtent(java.lang.String name)

Removes a named envelope from the quickview extents shown on the status bar.

getQuickViewExtents

public java.util.ArrayList getQuickViewExtents()

Gets the array of quickview extents, or null if no quickview extents exist.

Returns:

The array of quickview extents (as AimsEnvelope objects), or null if no quickview extents exist.

addMapScript

public void addMapScript(java.lang.String scriptName)

Adds a map script to the map script array.

Parameters:

scriptName - The file name of the map script. Must be in the IMF directory or a subdirectory.

getMapScripts

public java.util.ArrayList getMapScripts()

Gets the map script array, or null if there are not any.

Returns:

The array of startup script file names.

addStartupScript

public void addStartupScript(java.lang.String scriptName)

getStartupScripts

public java.util.ArrayList getStartupScripts()

usesLayerManager

public boolean usesLayerManager()

getAutoRefresh

public boolean getAutoRefresh()

Gets an indicator of whether the map autorefreshes.

Returns:

True if the map autorefreshes, otherwise false.

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)

Sets whether the map autorefreshes.

Parameters:

autoRefresh - True if the map should autorefresh, otherwise false.

getShowAutoRefresh

public boolean getShowAutoRefresh()

Gets an indicator of whether the map autorefresh message should display.

Returns:

True if the map autorefresh should display, otherwise false.

setShowAutoRefresh

public void setShowAutoRefresh(boolean showAutoRefresh)

Sets whether the map autorefresh message should display.

getIndexMapScriptUrl

public java.lang.String getIndexMapScriptUrl()

Gets the url of the index map script.

Returns:

The URL of the index map script.

getIndexMapScriptName

public java.lang.String getIndexMapScriptName()

getLayersScriptUrl

public java.lang.String getLayersScriptUrl()

Gets the url of the legend script.

Returns:

The URL of the legend script.

getLayersScriptName

public java.lang.String getLayersScriptName()

getLegendScriptUrl

public java.lang.String getLegendScriptUrl()

Gets the url of the legend script.

Returns:

The URL of the legend script.

getLegendScriptName

public java.lang.String getLegendScriptName()

getMaximumLayerManagerLayers

public java.lang.Integer getMaximumLayerManagerLayers()

Reports the maximum number of visible layers that can be shown using the layer manager.

Returns:

The number of layers.

setMaximumLayerManagerLayers

public void setMaximumLayerManagerLayers(int count)

Sets the maximum number of visible layers that can be shown using the layer manager.

Parameters:

count - The number of layers.

getLayerManagerLayersVisible

public boolean getLayerManagerLayersVisible()

Reports whether layers will be visible when added using the layer manager.

Returns:

True if they are visible, otherwise false.

setLayerManagerLayersVisible

public void setLayerManagerLayersVisible(boolean flag)

Sets whether layers will be visible when added using the layer manager.

Parameters:

flag - True if they are visible, otherwise false.

getStatusScriptUrl

public java.lang.String getStatusScriptUrl()

Gets the url of the status script.

Returns:

The URL of the status script.

showVersion

public boolean showVersion()

Gets whether the version number should be displayed on the layers page.

Returns:

True if the version number should be shown, otherwise false;

getMapDataFrame

public java.lang.String getMapDataFrame()

getIndexMapDataFrame

public java.lang.String getIndexMapDataFrame()

getTools

public java.util.Vector getTools()

getToolArray

public AimsWebSiteTool[] getToolArray()

getTool

public AimsWebSiteTool getTool(java.lang.String toolName)

getActiveToolName

public java.lang.String getActiveToolName()

addToolset

public void addToolset(AimsWebSiteToolset toolset)

getToolset

public AimsWebSiteToolset getToolset(java.lang.String toolsetName)

getToolsets

public java.util.ArrayList getToolsets()

getActiveToolset

public AimsWebSiteToolset getActiveToolset()

setActiveToolset

public void setActiveToolset(java.lang.String toolsetName)

getProjection

public AimsProjection getProjection()

setProjection

public void setProjection(AimsProjection projection)

getCenterCoordinateProjection

public AimsProjection getCenterCoordinateProjection()

setCenterCoordinateProjection

public void setCenterCoordinateProjection(AimsProjection projection)

clearIdentifyReportCoordinateProjections

public void clearIdentifyReportCoordinateProjections()

getIdentifyReportCoordinateProjections

public AimsProjection[] getIdentifyReportCoordinateProjections()

addIdentifyReportCoordinateProjection

public void addIdentifyReportCoordinateProjection(AimsProjection projection)

getFindLocationTypes

public AimsWebSiteFindLocationTypes getFindLocationTypes()

getFindLocationType

public AimsWebSiteFindLocationType getFindLocationType(java.lang.String type)

getCoordinateSystemZone

public int getCoordinateSystemZone()

setCoordinateSystemZone

public void setCoordinateSystemZone(int zone)

getThemeUrlPath

public java.lang.String getThemeUrlPath()

setThemeUrlPath

public void setThemeUrlPath(java.lang.String path)

getSiteUrl

public java.lang.String getSiteUrl()

getSiteUrlPath

public java.lang.String getSiteUrlPath()

setSiteUrl

public void setSiteUrl(java.lang.String href)

setSiteUrlPath

public void setSiteUrlPath(java.lang.String path)

setFrameworkUrlPath

public void setFrameworkUrlPath(java.lang.String path)

getFrameworkUrlPath

public java.lang.String getFrameworkUrlPath()

getMaximumScale

public double getMaximumScale()

getMinimumScale

public double getMinimumScale()

getNorthArrowSize

public int getNorthArrowSize()

Gets the size of the north arrow.

Returns:

The size of the north arrow.

getNorthArrowMaxScale

public double getNorthArrowMaxScale()

Gets the maximum scale that the north arrow is shown.

Returns:

The scale.

getBrowser

public java.lang.String getBrowser()

setBrowser

public void setBrowser(java.lang.String browser)

getWebmasterEmailAddress

public java.lang.String getWebmasterEmailAddress()

getWebmasterEmailSubject

public java.lang.String getWebmasterEmailSubject()

applyXmlThemes

public boolean applyXmlThemes(java.lang.String themeURL)

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

getScalebarUnits

public java.lang.String getScalebarUnits()

setScalebarUnits

public void setScalebarUnits(java.lang.String units)

setBackgroundColor

protected void setBackgroundColor(AimsColor color)

getBackgroundColor

public AimsColor getBackgroundColor()

isBackgroundTransparent

public boolean isBackgroundTransparent()

showNorthArrow

public boolean showNorthArrow()

showScalebar

public boolean showScalebar()

Returns a value indicating if the scalebar is to be shown.

Returns:

True if the scalebar is shown, otherwise false.

setCoordinateScript

public void setCoordinateScript(java.lang.String url)

getCoordinateScript

public java.lang.String getCoordinateScript()

showBrowserToolbar

public boolean showBrowserToolbar()

getMapCopyrightText

public java.lang.String getMapCopyrightText()

getMapLogoUrl

public java.lang.String getMapLogoUrl()

setInitialExtent

public void setInitialExtent(AimsEnvelope env)

setFullExtent

public void setFullExtent(AimsEnvelope env)

setMaximumExtent

public void setMaximumExtent(AimsEnvelope env)

getInitialExtent

public AimsEnvelope getInitialExtent()

getFullExtent

public AimsEnvelope getFullExtent()

getMaximumExtent

public AimsEnvelope getMaximumExtent()

setLayersXmlUrl

public void setLayersXmlUrl(java.lang.String layersXmlUrl)

getLayersXmlUrl

public java.lang.String getLayersXmlUrl()

setPrintXmlUrl

public void setPrintXmlUrl(java.lang.String url)

getPrintXmlUrl

public java.lang.String getPrintXmlUrl()

setThemesXmlUrl

public void setThemesXmlUrl(java.lang.String themesXmlUrl)

getThemesXmlUrl

public java.lang.String getThemesXmlUrl()

setEditToolsXmlUrl

public void setEditToolsXmlUrl(java.lang.String editToolsXmlUrl)

getEditToolsXmlUrl

public java.lang.String getEditToolsXmlUrl()

getMapDataframe

public java.lang.String getMapDataframe()

setMapDataframe

public void setMapDataframe(java.lang.String mapDataframe)

getMapServer

public java.lang.String getMapServer()

setMapServer

public void setMapServer(java.lang.String mapServer)

setIndexMapServer

public void setIndexMapServer(java.lang.String mapServer)

setMapServlet

public void setMapServlet(java.lang.String mapServlet)

setIndexMapServlet

public void setIndexMapServlet(java.lang.String indexMapServlet)

getMapServlet

public java.lang.String getMapServlet()

getMapService

public java.lang.String getMapService()

setMapService

public void setMapService(java.lang.String mapService)

setIndexMapService

public void setIndexMapService(java.lang.String mapService)

getIndexMapServer

public java.lang.String getIndexMapServer()

getIndexMapServlet

public java.lang.String getIndexMapServlet()

getIndexMapService

public java.lang.String getIndexMapService()

getWindowTitle

public java.lang.String getWindowTitle()

getTitleFrameUrl

public java.lang.String getTitleFrameUrl()

getTabFrameUrl

public java.lang.String getTabFrameUrl()

getToolFrameUrl

public java.lang.String getToolFrameUrl()

setToolFrameUrl

public void setToolFrameUrl(java.lang.String url)

getToolFrameHeight

public int getToolFrameHeight()

setToolFrameHeight

public void setToolFrameHeight(int height)

getDataFrameUrl

public java.lang.String getDataFrameUrl()

getDataFrameWidth

public int getDataFrameWidth()

getHiddenFrameWidth

public int getHiddenFrameWidth()

getDataFramePosition

public java.lang.String getDataFramePosition()

getThemes

public java.util.Vector getThemes()

getToolPosition

public java.lang.String getToolPosition()

getMapFrameUrl

public java.lang.String getMapFrameUrl()

setTitleFrameUrl

public void setTitleFrameUrl(java.lang.String url)

getTitleFrameHeight

public int getTitleFrameHeight()

getStatusFrameUrl

public java.lang.String getStatusFrameUrl()

setStatusFrameUrl

public void setStatusFrameUrl(java.lang.String url)

getStatusFrameHeight

public int getStatusFrameHeight()

getHiddenFrameUrl

public java.lang.String getHiddenFrameUrl()

setHiddenFrameUrl

public void setHiddenFrameUrl(java.lang.String url)

getTabs

public java.util.Vector getTabs()

getTabDecorationLeftUrl

public java.lang.String getTabDecorationLeftUrl()

getTabDecorationLeftWidth

public int getTabDecorationLeftWidth()

getTabDecorationLeftHeight

public int getTabDecorationLeftHeight()

getTabDecorationRightUrl

public java.lang.String getTabDecorationRightUrl()

getTabDecorationRightWidth

public int getTabDecorationRightWidth()

getTabDecorationRightHeight

public int getTabDecorationRightHeight()

getTabDecorationSpaceUrl

public java.lang.String getTabDecorationSpaceUrl()

getTabDecorationSpaceWidth

public int getTabDecorationSpaceWidth()

getTabDecorationSpaceHeight

public int getTabDecorationSpaceHeight()

getPrintMapLegend

public boolean getPrintMapLegend()

Gets a boolean indicator of whether to include the legend on the printed map.

Returns:

True if the legend should be printed, otherwise false.

setPrintMapLegend

public void setPrintMapLegend(boolean printLegend)

Sets whether to include the legend on the printed map.

Parameters:

printLegend - True if the legend should be printed, otherwise false.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property set in the configuration XML using a <property> element.

Parameters:

name - The property name

Returns:

The property value, or null.

removeProperty

public void removeProperty(java.lang.String name)

Removes the specified property.

Parameters:

name - The name of the property.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Parameters:

name - The property name

value - The property value.

addMxdTemplate

public void addMxdTemplate(AimsMxdTemplate template)

Adds an MXD template to support plotting using other services.

Parameters:

template - The MXD template to add.

getMxdTemplate

public AimsMxdTemplate getMxdTemplate(java.lang.String name)

Gets the MXD template with the specified name, or null.

Parameters:

name - The name of the template.

Returns:

The template matching the name, or null.

getMxdTemplates

public java.util.ArrayList getMxdTemplates()

Gets an ArrayList of templates, or null.

Returns:

The templates in an array list.

hasMxdTemplates

public boolean hasMxdTemplates()

Returns an indicator of whether there are any MXD templates.

Returns:

True if there are templates, otherwise false.

showLayerListLegends

public void showLayerListLegends(boolean show)

showLayerListLegends

public boolean showLayerListLegends()

getPrintTemplates

public Templates getPrintTemplates()

getSelectMenuOptions

public AimsWebSiteSelectMenuOptions getSelectMenuOptions()

showPanBorder

public boolean showPanBorder()

getPanBorderOverColor

public AimsColor getPanBorderOverColor()

getPanBorderOutColor

public AimsColor getPanBorderOutColor()