OpenLayers.Format.GML.Base

Superclass for GML parsers.

Inherits from

OpenLayers.Format.XML

Summary

OpenLayers.Format.GML.Base	Superclass for GML parsers.
Properties
namespaces	{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
schemaLocation	{String} Schema location for a particular minor version.
featureType	{Array(String) or String} The local (without prefix) feature typeName(s).
featureNS	{String} The feature namespace.
geometry	{String} Name of geometry element.
extractAttributes	{Boolean} Extract attributes from GML.
srsName	{String} URI for spatial reference system.
xy	{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
geometryTypes	{Object} Maps OpenLayers geometry class names to GML element names.
singleFeatureType	{Boolean} True if there is only 1 featureType, and not an array of featuretypes.
regExes	Compiled regular expressions for manipulating strings.
Constructor
OpenLayers.Format.GML.Base	Instances of this class are not created directly.
Functions and Properties
read
readers	Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
write
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.
setGeometryTypes	Sets the geometryTypes mapping.

Properties

namespaces

{Object} Mapping of namespace aliases to namespace URIs.

defaultPrefix

schemaLocation

{String} Schema location for a particular minor version.

featureType

{Array(String) or String} The local (without prefix) feature typeName(s).

featureNS

{String} The feature namespace. Must be set in the options at construction.

geometry

{String} Name of geometry element. Defaults to “geometry”.

extractAttributes

{Boolean} Extract attributes from GML. Default is true.

srsName

{String} URI for spatial reference system. This is optional for single part geometries and mandatory for collections and multis. If set, the srsName attribute will be written for all geometries. Default is null.

xy

{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.

geometryTypes

{Object} Maps OpenLayers geometry class names to GML element names. Use setGeometryTypes before accessing this property.

singleFeatureType

{Boolean} True if there is only 1 featureType, and not an array of featuretypes.

regExes

Compiled regular expressions for manipulating strings.

Constructor

OpenLayers.Format.GML.Base

Instances of this class are not created directly. Use the OpenLayers.Format.GML.v2 or OpenLayers.Format.GML.v3 constructor instead.

Parameters

options

{Object} An optional object whose properties will be set on this instance.

Valid options properties

featureType	{Array(String) or String} Local (without prefix) feature typeName(s) (required).
featureNS	{String} Feature namespace (required).
geometryName	{String} Geometry element name.

Functions and Properties

read

read: function( data )

Parameters

data	{DOMElement} A gml:featureMember element, a gml:featureMembers element, or an element containing either of the above at any level.

Returns

{Array(OpenLayers.Feature.Vector)} An array of features.

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.

write

write: function( features )

Parameters

features

{Array(OpenLayers.Feature.Vector) | OpenLayers.Feature.Vector} An array of features or a single feature.

Returns

{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned.

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.

setGeometryTypes

setGeometryTypes: function()

Sets the geometryTypes mapping.