Class OwsContext

Object
   |
   +--Listener
         |
         +--ModelBase
               |
               +--OwsContext

class OwsContext

extends ModelBase

Author: Mike Adair
Defined in OwsContext.js

Requires:

- Sarissa

Field Detail

namespace

Object namespace

OwsContext

OwsContext(modelNode, parent)

Stores an OWS Context document as defined by the OGC interoperability experiment. This model should be eventually merged with the standard OGC context doc. Listeners supported by this model: "refresh" called when window parameters (width/height, bbox) are changed "hidden" called when visibilty of a layer is changed "wfs_getFeature" called when feature resources are loaded

Author: Mike Adair
Requires:
- Sarissa

addLayer

void addLayer(objRef, layerNode)

Method to add a Layer to the LayerList

Parameters:
layerNode - the Layer node from another context doc or capabiltiies doc

addSLD

void addSLD(objRef,sldNode)

Method to add a Sld to the StyleList

Parameters:
layerName - the Layer name from another context doc or capabiltiies doc TBD: make sure this will work again using layerId instead of layerName

clearTimeExtent

void clearTimeExtent( objRef )

clear the time extent created by initTimeExtent

Parameters:
objRef - reference to this model

deleteLayer

void deleteLayer(objRef, layerId)

Method to remove a Layer from the LayerList

Parameters:
layerId - the Layer to be deleted

getAllLayers

Object getAllLayers()

Method to get a list of all layers in the context doc TBD: merge this with above, passing queryable as an optional boolean param?

Returns:
the list with all layers

getBaseLayer

Object getBaseLayer()

Method to get the baselayer

Returns:
the baseLayer

getBaseLayerService

Object getBaseLayerService()

Return the service type of the bottom layer in the layer list. This is used to match navigation tools with the basemap.

getBoundingBox

Object getBoundingBox()

Get the BoundingBox value from the Context document.

Returns:
BoundingBox array with the sequence (xmin,ymin,xmax,ymax).

getCurrentTimestamp

Object getCurrentTimestamp( layerName )

Returns the current timestamp value.

Parameters:
layerName - the name of the Layer from which the timestamp list was generated

Returns:
the current timestamp value.

getExtension

Object getExtension()

Returns the contents of the extension element

Returns:
the contents of the extension element

getFeatureNode

Object getFeatureNode(layerId)

returns a node that has the specified feature name in the context doc

Parameters:
featureName - Name element value to return

Returns:
the node from the context doc with the specified feature name

getHidden

Object getHidden(layerId)

Get the layer's visiblity attribute value.

Parameters:
layerId - The name of the layer that is to be changed

Returns:
hidden String with the value; 1=hidden, 0=visible.

getLayer

Object getLayer(layerId)

Method to get a layer with the specified id/name in the context doc

Parameters:
layerId - /layerName the layer to be returned

Returns:
the list with all layers

getLayerIdByName

Object getLayerIdByName(layerName)

Method to get a layer id with the specified id/name in the context doc

Parameters:
layerName - the name of the layer of which the id is to be returned

Returns:
the id of the layer || false

getMethod

Object getMethod(feature)

Get HTTP method for the specified feature

Parameters:
feature - the Layer node from the context doc

Returns:
the HTTP method to get the feature with

getOpacity

Object getOpacity(layerId)

Get the layer's opacity attribute value.

Parameters:
layerId - The name of the layer that is to be changed

Returns:
hidden String with the value; 1=hidden, 0=visible.

getQueryableLayers

Object getQueryableLayers()

Method to get a list of queryable layers

Returns:
the list with queryable layers

getServerUrl

Object getServerUrl(requestName, method, feature)

Returns the serverUrl for the layer passed in as the feature argument.

Parameters:
requestName - ignored for context docs (only GetMap supported)
method - ignored for context docs (only GET supported)
feature - the node for the feature from the context doc

Returns:
height String URL for the GetMap request

getSRS

Object getSRS()

Get the Spatial Reference System from the context document.

Returns:
srs The Spatial Reference System.

getVersion

Object getVersion(feature)

Returns the WMS version for the layer passed in as the feature argument

Parameters:
feature - the node for the feature from the context doc

Returns:
the WMS GetMap version for the Layer.

getWindowHeight

Object getWindowHeight()

Get the Window height.

Returns:
height The height of map window from the context document.

getWindowSize

Object getWindowSize()

getWindowWidth

Object getWindowWidth()

Get the Window width.

Returns:
width The width of map window from the context document

initAoi

void initAoi(objRef)

Set the aoi param and call the refresh listeners

Parameters:
boundingBox - array in the sequence (xmin, ymin, xmax, ymax).

initBbox

void initBbox(objRef)

Set the BoundingBox element and call the refresh listeners

Parameters:
boundingBox - array in the sequence (xmin, ymin, xmax, ymax).

initProj

Object initProj(objRef)

Get the Projection object from the context document.

Returns:
Proj Object of The Spatial Reference System.

initTimeExtent

void initTimeExtent( objRef )

Parses a Dimension element from the Context document as a loadModel listener. This results in an XML structure with one element for each GetMap time value parameter and added to the Context extrension element.

Parameters:
objRef - a pointer to this object

loadFeatures

void loadFeatures(objRef)

listener method which loads WFS features from the context doc, after WMS layers are loaded.

Parameters:
objRef - Pointer to this object.

moveLayerDown

void moveLayerDown(objRef, layerId)

Method to move a Layer in the LayerList down

Parameters:
layerId - the layer to be moved

moveLayerUp

void moveLayerUp(objRef, layerId)

Method to move a Layer in the LayerList up

Parameters:
layerId - the layer to be moved

setBoundingBox

void setBoundingBox(boundingBox)

Set the BoundingBox element and call the refresh listeners

Parameters:
boundingBox - array in the sequence (xmin, ymin, xmax, ymax).

setExtension

Object setExtension(extensionNode)

Adds a node to the Context document extension element. The extension element will be created if it doesn't already exist.

Parameters:
extensionNode - the node to be appended in the extension element.

Returns:
the ndoe added to the extension element

setHidden

void setHidden(layerId, hidden)

Change a Layer's visibility.

Parameters:
layerId - The name of the layer that is to be changed
hidden - String with the value to be set; 1=hidden, 0=visible.

setOpacity

void setOpacity(layerId, Opacity)

Change a Layer's opacity

Parameters:
layerId - The name of the layer that is to be changed
Opacity - Value of the opacity

setRequestParameters

void setRequestParameters(featureName, requestStylesheet)

Listener function which sets stylesheet params for WebServiceRequests

Parameters:
objRef - pointer to this object
featureNodeId - the id of the node in the doc to be processed by the stylesheet

setSRS

void setSRS(srs)

Set the Spatial Reference System for the context document.

Parameters:
srs - The Spatial Reference System.

setWindowHeight

void setWindowHeight(height)

Set the Window height.

Parameters:
height - The height of map window to set in the context document

setWindowSize

void setWindowSize(size)

setWindowWidth

void setWindowWidth(width)

Set the Window width.

Parameters:
width - The width of map window to set in the context document