/* Copyright (c) 2006-2010 by OpenLayers Contributors (see authors.txt for
* full list of contributors). Published under the Clear BSD license.
* See http://svn.openlayers.org/trunk/openlayers/license.txt for the
* full text of the license. */
/**
* @requires OpenLayers/Format/XML.js
* @requires OpenLayers/Format/GML.js
* @requires OpenLayers/Format/GML/v3.js
*/
/**
* Class: OpenLayers.Format.SOSGetObservation
* Read and write SOS GetObersation (to get the actual values from a sensor)
* version 1.0.0
*
* Inherits from:
* - <OpenLayers.Format.XML>
*/
OpenLayers.Format.SOSGetObservation = OpenLayers.Class(OpenLayers.Format.XML, {
/**
* Property: namespaces
* {Object} Mapping of namespace aliases to namespace URIs.
*/
namespaces: {
ows: "http://www.opengis.net/ows",
gml: "http://www.opengis.net/gml",
sos: "http://www.opengis.net/sos/1.0",
ogc: "http://www.opengis.net/ogc",
om: "http://www.opengis.net/om/1.0",
xlink: "http://www.w3.org/1999/xlink",
xsi: "http://www.w3.org/2001/XMLSchema-instance"
},
/**
* Property: regExes
* Compiled regular expressions for manipulating strings.
*/
regExes: {
trimSpace: (/^\s*|\s*$/g),
removeSpace: (/\s*/g),
splitSpace: (/\s+/),
trimComma: (/\s*,\s*/g)
},
/**
* Constant: VERSION
* {String} 1.0.0
*/
VERSION: "1.0.0",
/**
* Property: schemaLocation
* {String} Schema location
*/
schemaLocation: "http://www.opengis.net/sos/1.0 http://schemas.opengis.net/sos/1.0.0/sosGetObservation.xsd",
/**
* Property: defaultPrefix
*/
defaultPrefix: "sos",
/**
* Constructor: OpenLayers.Format.SOSGetObservation
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
initialize: function(options) {
OpenLayers.Format.XML.prototype.initialize.apply(this, [options]);
},
/**
* Method: read
*
* Parameters:
* data - {String} or {DOMElement} data to read/parse.
*
* Returns:
* {Object} An object containing the measurements
*/
read: function(data) {
if(typeof data == "string") {
data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
}
if(data && data.nodeType == 9) {
data = data.documentElement;
}
var info = {measurements: []};
this.readNode(data, info);
return info;
},
/**
* Method: write
*
* Parameters:
* options - {Object} Optional object.
*
* Returns:
* {String} An SOS GetObservation request XML string.
*/
write: function(options) {
var node = this.writeNode("sos:GetObservation", options);
node.setAttribute("xmlns:om", this.namespaces.om);
this.setAttributeNS(
node, this.namespaces.xsi,
"xsi:schemaLocation", this.schemaLocation
);
return OpenLayers.Format.XML.prototype.write.apply(this, [node]);
},
/**
* Property: readers
* Contains public functions, grouped by namespace prefix, that will
* be applied when a namespaced node is found matching the function
* name. The function will be applied in the scope of this parser
* with two arguments: the node being read and a context object passed
* from the parent.
*/
readers: {
"om": {
"ObservationCollection": function(node, obj) {
obj.id = this.getAttributeNS(node, this.namespaces.gml, "id");
this.readChildNodes(node, obj);
},
"member": function(node, observationCollection) {
this.readChildNodes(node, observationCollection);
},
"Measurement": function(node, observationCollection) {
var measurement = {};
observationCollection.measurements.push(measurement);
this.readChildNodes(node, measurement);
},
"samplingTime": function(node, measurement) {
var samplingTime = {};
measurement.samplingTime = samplingTime;
this.readChildNodes(node, samplingTime);
},
"observedProperty": function(node, measurement) {
measurement.observedProperty =
this.getAttributeNS(node, this.namespaces.xlink, "href");
this.readChildNodes(node, measurement);
},
"procedure": function(node, measurement) {
measurement.procedure =
this.getAttributeNS(node, this.namespaces.xlink, "href");
this.readChildNodes(node, measurement);
},
"result": function(node, measurement) {
var result = {};
measurement.result = result;
if (this.getChildValue(node) !== '') {
result.value = this.getChildValue(node);
result.uom = node.getAttribute("uom");
} else {
this.readChildNodes(node, result);
}
}
},
"gml": OpenLayers.Util.applyDefaults({
"TimeInstant": function(node, samplingTime) {
var timeInstant = {};
samplingTime.timeInstant = timeInstant;
this.readChildNodes(node, timeInstant);
},
"timePosition": function(node, timeInstant) {
timeInstant.timePosition = this.getChildValue(node);
}
}, OpenLayers.Format.GML.v3.prototype.readers.gml)
},
/**
* Property: writers
* As a compliment to the readers property, this structure contains public
* writing functions grouped by namespace alias and named like the
* node names they produce.
*/
writers: {
"sos": {
"GetObservation": function(options) {
var node = this.createElementNSPlus("GetObservation", {
attributes: {
version: this.VERSION,
service: 'SOS'
}
});
this.writeNode("offering", options, node);
this.writeNode("eventTime", options, node);
this.writeNode("procedure", options, node);
this.writeNode("observedProperty", options, node);
this.writeNode("responseFormat", options, node);
this.writeNode("resultModel", options, node);
this.writeNode("responseMode", options, node);
return node;
},
"responseFormat": function(options) {
return this.createElementNSPlus("responseFormat",
{value: options.responseFormat});
},
"procedure": function(options) {
return this.createElementNSPlus("procedure",
{value: options.procedure});
},
"offering": function(options) {
return this.createElementNSPlus("offering", {value:
options.offering});
},
"observedProperty": function(options) {
return this.createElementNSPlus("observedProperty",
{value: options.observedProperty});
},
"eventTime": function(options) {
var node = this.createElementNSPlus("eventTime");
if (options.eventTime === 'latest') {
this.writeNode("ogc:TM_Equals", options, node);
}
return node;
},
"resultModel": function(options) {
return this.createElementNSPlus("resultModel", {value:
options.resultModel});
},
"responseMode": function(options) {
return this.createElementNSPlus("responseMode", {value:
options.responseMode});
}
},
"ogc": {
"TM_Equals": function(options) {
var node = this.createElementNSPlus("ogc:TM_Equals");
this.writeNode("ogc:PropertyName", {property:
"urn:ogc:data:time:iso8601"}, node);
if (options.eventTime === 'latest') {
this.writeNode("gml:TimeInstant", {value: 'latest'}, node);
}
return node;
},
"PropertyName": function(options) {
return this.createElementNSPlus("ogc:PropertyName",
{value: options.property});
}
},
"gml": {
"TimeInstant": function(options) {
var node = this.createElementNSPlus("gml:TimeInstant");
this.writeNode("gml:timePosition", options, node);
return node;
},
"timePosition": function(options) {
var node = this.createElementNSPlus("gml:timePosition",
{value: options.value});
return node;
}
}
},
CLASS_NAME: "OpenLayers.Format.SOSGetObservation"
});