Class ModelBase

Object
   |
   +--Listener
         |
         +--ModelBase

Direct Known Subclasses:

GeoRSS, FeatureCollection, Config, Model, Transaction, StyledLayerDescriptor, WmsCapabilities, Context, OwsContext, WpsCapabilities, Logger, WpsDescribeProcess, WfsCapabilities

class ModelBase

extends Listener

Defined in ModelBase.js

Author: Cameron Shorter

Field Detail

async

Object async

config

Object config

Widgets can place configurations in a model. This is an associative array with the widgetId of the widget that places its configuration here as key.

contentType

Object contentType

debug

Object debug

id

Object id

method

Object method

modelNode

Object modelNode

namespace

Object namespace

nodeSelectXpath

Object nodeSelectXpath

parentModel

Object parentModel

template

Object template

title

Object title

url

Object url

ModelBase

ModelBase(modelNode, parentModel)

Base Model class to be inherited by all Model objects and provdes methods and properties common to all models. Stores the XML document as the .doc property of the model. Inherits from the Listener class so all models are also listener objects that can call registered listeners.

Parameters:
modelNode - The model's XML object node from the configuration document.
parentModel - The model object that this model belongs to.

Author: Cameron Shorter

clearModel

void clearModel(objRef)

Listener registered with the parent model to remove the doc and url of child models whenever the parent is reloaded.

Parameters:
objRef - Pointer to this object.

createObject

Object createObject(configNode)

Creates all mapbuilder JavaScript objects based on the Object nodes defined in the configuration file. A reference to the created model is stored as a property of the config.objects property using the model's ID; you can always get a reference to a mapbuilder object as: "config.objects.objectId"

Parameters:
configNode - The node from config for the model to be created

deleteTemplates

void deleteTemplates()

deletes all template models and clears their widgets

finishLoading

void finishLoading()

Common steps to be carried out after all manner of model loading Called to set the namespace for XPath selections and call the loadModel listeners.

getProperty

Object getProperty(property, defaultValue)

Convenient access to Mapbuilder.getProperty

Parameters:
property - property to get
default - value to use if property is not set

Returns:
the value for the property

getXpathValue

Object getXpathValue(objRef,xpath)

Get the value of a node as selected by an XPath expression.1

Parameters:
objRef - Reference to this node.
xpath - XPath of the node to update.

Returns:
value of the node or null if XPath does not find a node.

init

void init(objRef)

Listener registered with the parent model to call init listeners when the parent model is init'ed

Parameters:
objRef - Pointer to this object.

loadModelDoc

void loadModelDoc(objRef)

Load a Model's document. This will only occur if the model.url property is set. Calling this method triggers several events: modelStatus - to indicate that the model state is changing newModel - to give widgets a chance to clear themselves before the doc is loaded loadModel - to indicate that the document is loaded successfully

Parameters:
objRef - Pointer to the model object being loaded.

loadObjects

void loadObjects(objectXpath)

Creates all the mapbuilder objects from the config file as selected by the XPath value passed in.

Parameters:
objectXpath - The XPath for the set of nodes being created

newRequest

void newRequest(objRef, httpPayload)

Load XML for a model from an httpPayload object. This will also handle instantiating template models if they have the "template" attribute set. To update model data, use:
httpPayload=new Object();
httpPayload.url="url" or null. If set to null, all dependant widgets will be removed from the display.
httpPayload.httpMethod="post" or "get"
httpPayload.postData=XML or null

Parameters:
objRef - Pointer to the model object being loaded.
httpPayload - an object to fully specify the request to be made

parseConfig

void parseConfig(objRef)

Initialization of all javascript model, widget and tool objects for this model. Calling this method triggers an init event for this model.

Parameters:
objRef - Pointer to this object.

refresh

void refresh(objRef)

Listener registered with the parent model to call refresh listeners when the model document is loaded

Parameters:
objRef - Pointer to this object.

saveModel

void saveModel(objRef)

save the model by posting it to the serializeUrl, which is defined as a property of config.

Parameters:
objRef - Pointer to this object.

setModel

void setModel(objRef,newModel)

Set the model's XML document using an XML object as a parameter.

Parameters:
objRef - Pointer to this object.
newModel - XML object to be inserted into the new model.

setXpathValue

Object setXpathValue(objRef,xpath,value,refresh)

Update the value of a node within this model's XML document. Triggers a refresh event from the model.

Parameters:
objRef - Reference to this node.
xpath - Xpath of the node to update.
value - Node's new value.
refresh - determines if the model should be refreshed (optional).

Returns:
Returns false if Xpath does not find a node.