1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <html><head><title>OpenLayers.Protocol.SQL.Gears - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../../../styles/main.css"><script language=JavaScript src="../../../../javascript/main.js"></script><script language=JavaScript src="../../../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4 if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
6 <!-- Generated by Natural Docs, version 1.4 -->
7 <!-- http://www.naturaldocs.org -->
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
14 <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears"></a>OpenLayers.<wbr>Protocol.<wbr>SQL.<wbr>Gears</h1><div class=CBody><p>This Protocol stores feature in the browser via the Gears Database module <a href="http://code.google.com/apis/gears/api_database.html" class=LURL target=_top>http://code.google.com<wbr>/apis<wbr>/gears<wbr>/api_database.html</a>.</p><p>The main advantage is that all the read, create, update and delete operations can be done offline.</p><h4 class=CHeading>Inherits from</h4><ul><li><a href="../SQL-js.html#OpenLayers.Protocol.SQL" class=LClass id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">OpenLayers.Protocol.SQL</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears" >OpenLayers.<wbr>Protocol.<wbr>SQL.<wbr>Gears</a></td><td class=SDescription>This Protocol stores feature in the browser via the Gears Database module <a href="http://code.google.com/apis/gears/api_database.html" class=LURL target=_top>http://code.google.com<wbr>/apis<wbr>/gears<wbr>/api_database.html</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.FID_PREFIX" >FID_PREFIX</a></td><td class=SDescription>{String}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.NULL_GEOMETRY" >NULL_GEOMETRY</a></td><td class=SDescription>{String}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.NULL_FEATURE_STATE" >NULL_FEATURE_STATE</a></td><td class=SDescription>{String}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.jsonParser" >jsonParser</a></td><td class=SDescription>{<a href="../../Format/JSON-js.html#OpenLayers.Format.JSON" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Format.JSON</a>}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.wktParser" >wktParser</a></td><td class=SDescription>{<a href="../../Format/WKT-js.html#OpenLayers.Format.WKT" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">OpenLayers.Format.WKT</a>}</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.fidRegExp" >fidRegExp</a></td><td class=SDescription>{RegExp} Regular expression to know whether a feature was created in offline mode.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.saveFeatureState" >saveFeatureState</a></td><td class=SDescription>{Boolean} Whether to save the feature state (<OpenLayers.State>) into the database, defaults to true.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.typeOfFid" >typeOfFid</a></td><td class=SDescription>{String} The type of the feature identifier, either “number” or “string”, defaults to “string”.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.db" >db</a></td><td class=SDescription>{GearsDatabase}</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.OpenLayers.Protocol.SQL.Gears" >OpenLayers.<wbr>Protocol.<wbr>SQL.<wbr>Gears</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.initializeDatabase" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">initializeDatabase</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.destroy" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">destroy</a></td><td class=SDescription>Clean up the protocol.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.supported" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">supported</a></td><td class=SDescription>Determine whether a browser supports Gears</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.read" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">read</a></td><td class=SDescription>Read all features from the database and return a <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> instance. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.unfreezeFeature" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">unfreezeFeature</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.extractFidFromField" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">extractFidFromField</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.create" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">create</a></td><td class=SDescription>Create new features into the database.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.update" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">update</a></td><td class=SDescription>Construct a request updating modified feature.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.createOrUpdate" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">createOrUpdate</a></td><td class=SDescription>Construct a request for updating or creating features in the database.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.freezeFeature" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">freezeFeature</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.getFeatureStateForFreeze" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">getFeatureStateForFreeze</a></td><td class=SDescription>Get the state of the feature to store into the database.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.delete" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">delete</a></td><td class=SDescription>Delete features from the database.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.createdOffline" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">createdOffline</a></td><td class=SDescription>Returns true if the feature had a feature id when it was created in the Gears database, false otherwise; this is determined by checking the form of the feature’s fid value.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.commit" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">commit</a></td><td class=SDescription>Go over the features and for each take action based on the feature state. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.clear" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">clear</a></td><td class=SDescription>Removes all rows of the table.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Protocol.SQL.Gears.callUserCallback" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">callUserCallback</a></td><td class=SDescription>This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.Properties"></a>Properties</h3></div></div>
18 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.FID_PREFIX"></a>FID_PREFIX</h3><div class=CBody><p>{String}</p></div></div></div>
20 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.NULL_GEOMETRY"></a>NULL_GEOMETRY</h3><div class=CBody><p>{String}</p></div></div></div>
22 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.NULL_FEATURE_STATE"></a>NULL_FEATURE_STATE</h3><div class=CBody><p>{String}</p></div></div></div>
24 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.jsonParser"></a>jsonParser</h3><div class=CBody><p>{<a href="../../Format/JSON-js.html#OpenLayers.Format.JSON" class=LClass id=link21 onMouseOver="ShowTip(event, 'tt1', 'link21')" onMouseOut="HideTip('tt1')">OpenLayers.Format.JSON</a>}</p></div></div></div>
26 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.wktParser"></a>wktParser</h3><div class=CBody><p>{<a href="../../Format/WKT-js.html#OpenLayers.Format.WKT" class=LClass id=link22 onMouseOver="ShowTip(event, 'tt2', 'link22')" onMouseOut="HideTip('tt2')">OpenLayers.Format.WKT</a>}</p></div></div></div>
28 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.fidRegExp"></a>fidRegExp</h3><div class=CBody><p>{RegExp} Regular expression to know whether a feature was created in offline mode.</p></div></div></div>
30 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.saveFeatureState"></a>saveFeatureState</h3><div class=CBody><p>{Boolean} Whether to save the feature state (<OpenLayers.State>) into the database, defaults to true.</p></div></div></div>
32 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.typeOfFid"></a>typeOfFid</h3><div class=CBody><p>{String} The type of the feature identifier, either “number” or “string”, defaults to “string”.</p></div></div></div>
34 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.db"></a>db</h3><div class=CBody><p>{GearsDatabase}</p></div></div></div>
36 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.Constructor"></a>Constructor</h3></div></div>
38 <div class="CConstructor"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.OpenLayers.Protocol.SQL.Gears"></a>OpenLayers.<wbr>Protocol.<wbr>SQL.<wbr>Gears</h3></div></div>
40 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.Functions"></a>Functions</h3></div></div>
42 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.initializeDatabase"></a>initializeDatabase</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>initializeDatabase: function()</td></tr></table></blockquote></div></div></div>
44 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote><p>Clean up the protocol.</p></div></div></div>
46 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.supported"></a>supported</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>supported: function()</td></tr></table></blockquote><p>Determine whether a browser supports Gears</p><h4 class=CHeading>Returns</h4><p>{Boolean} The browser supports Gears</p></div></div></div>
48 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.read"></a>read</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>read: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Read all features from the database and return a <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link23 onMouseOver="ShowTip(event, 'tt7', 'link23')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> instance. If the options parameter contains a callback attribute, the function is called with the response as a parameter.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Optional object for configuring the request; it can have the {Boolean} property “noFeatureStateReset” which specifies if the state of features read from the Gears database must be reset to null, if “noFeatureStateReset” is undefined or false then each feature’s state is reset to null, if “noFeatureStateReset” is true the feature state is preserved.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link24 onMouseOver="ShowTip(event, 'tt7', 'link24')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>} An <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link25 onMouseOver="ShowTip(event, 'tt7', 'link25')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> object.</p></div></div></div>
50 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.unfreezeFeature"></a>unfreezeFeature</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>unfreezeFeature: function(</td><td class=PParameter nowrap>row</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>row</td><td class=CDLDescription>{ResultSet}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link26 onMouseOver="ShowTip(event, 'tt21', 'link26')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>}</p></div></div></div>
52 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.extractFidFromField"></a>extractFidFromField</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>extractFidFromField: function(</td><td class=PParameter nowrap>field</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>field</td><td class=CDLDescription>{String}</td></tr></table><p>Returns {String} or {Number} The fid.</p></div></div></div>
54 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.create"></a>create</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>create: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Create new features into the database.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>features</td><td class=CDLDescription>{Array({<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link27 onMouseOver="ShowTip(event, 'tt21', 'link27')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>})} or {<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link28 onMouseOver="ShowTip(event, 'tt21', 'link28')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>} The features to create in the database.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Optional object for configuring the request.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link29 onMouseOver="ShowTip(event, 'tt7', 'link29')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>} An <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link30 onMouseOver="ShowTip(event, 'tt7', 'link30')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> object.</p></div></div></div>
56 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.update"></a>update</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>update: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Construct a request updating modified feature.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>features</td><td class=CDLDescription>{Array({<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link31 onMouseOver="ShowTip(event, 'tt21', 'link31')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>})} or {<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link32 onMouseOver="ShowTip(event, 'tt21', 'link32')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>} The features to update in the database.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Optional object for configuring the request.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link33 onMouseOver="ShowTip(event, 'tt7', 'link33')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>} An <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link34 onMouseOver="ShowTip(event, 'tt7', 'link34')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> object.</p></div></div></div>
58 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.createOrUpdate"></a>createOrUpdate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>createOrUpdate: function(</td><td class=PParameter nowrap>features</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Construct a request for updating or creating features in the database.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>features</td><td class=CDLDescription>{Array({<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link35 onMouseOver="ShowTip(event, 'tt21', 'link35')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>})} or {<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link36 onMouseOver="ShowTip(event, 'tt21', 'link36')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>} The feature to create or update in the database.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link37 onMouseOver="ShowTip(event, 'tt7', 'link37')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>} An <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link38 onMouseOver="ShowTip(event, 'tt7', 'link38')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> object.</p></div></div></div>
60 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.freezeFeature"></a>freezeFeature</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>freezeFeature: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>feature</td><td class=CDLDescription>{<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link39 onMouseOver="ShowTip(event, 'tt21', 'link39')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>}</td></tr><tr><td class=CDLEntry>state</td><td class=CDLDescription>{String} The feature state to store in the database.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array}</p></div></div></div>
62 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.getFeatureStateForFreeze"></a>getFeatureStateForFreeze</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getFeatureStateForFreeze: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get the state of the feature to store into the database.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>feature</td><td class=CDLDescription>{<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt21', 'link40')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>} The feature.</td></tr></table><p>Returns {String} The state</p></div></div></div>
64 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.delete"></a>delete</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>"delete": function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Delete features from the database.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>features</td><td class=CDLDescription>{Array({<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt21', 'link41')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>})} or {<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt21', 'link42')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>}</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Optional object for configuring the request. This object is modified and should not be reused.</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link43 onMouseOver="ShowTip(event, 'tt7', 'link43')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>} An <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link44 onMouseOver="ShowTip(event, 'tt7', 'link44')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> object.</p></div></div></div>
66 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.createdOffline"></a>createdOffline</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>createdOffline: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the feature had a feature id when it was created in the Gears database, false otherwise; this is determined by checking the form of the feature’s fid value.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>feature</td><td class=CDLDescription>{<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link45 onMouseOver="ShowTip(event, 'tt21', 'link45')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean}</p></div></div></div>
68 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.commit"></a>commit</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>commit: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Go over the features and for each take action based on the feature state. Possible actions are create, update and delete.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>features</td><td class=CDLDescription>{Array({<a href="../../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt21', 'link46')" onMouseOut="HideTip('tt21')">OpenLayers.Feature.Vector</a>})}</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Object whose possible keys are “create”, “update”, “delete”, “callback” and “scope”, the values referenced by the first three are objects as passed to the “create”, “update”, and “delete” methods, the value referenced by the “callback” key is a function which is called when the commit operation is complete using the scope referenced by the “scope” key.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array({<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt7', 'link47')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>})} An array of <a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link48 onMouseOver="ShowTip(event, 'tt7', 'link48')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a> objects, one per request made to the database.</p></div></div></div>
70 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.clear"></a>clear</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote><p>Removes all rows of the table.</p></div></div></div>
72 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Protocol.SQL.Gears.callUserCallback"></a>callUserCallback</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>callUserCallback: function(</td><td class=PParameter nowrap>options,</td></tr><tr><td></td><td class=PParameter nowrap>resp</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} The map of options passed to the commit call.</td></tr><tr><td class=CDLEntry>resp</td><td class=CDLDescription>{<a href="../../Protocol-js.html#OpenLayers.Protocol.Response" class=LClass id=link49 onMouseOver="ShowTip(event, 'tt7', 'link49')" onMouseOut="HideTip('tt7')">OpenLayers.Protocol.Response</a>}</td></tr></table></div></div></div>
77 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
80 <div id=Menu><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent29')">OpenLayers</a><div class=MGroupContent id=MGroupContent29><div class=MEntry><div class=MFile><a href="../../../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MFile><a href="../../Ajax-js.html">Ajax</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">BaseTypes</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../../BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/Bounds-js.html">Bounds</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/Class-js.html">Class</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/Element-js.html">Element</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/LonLat-js.html">LonLat</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/Pixel-js.html">Pixel</a></div></div><div class=MEntry><div class=MFile><a href="../../BaseTypes/Size-js.html">Size</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Console-js.html">Console</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Control</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../../Control-js.html">Control</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Control</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../../Control/ArgParser-js.html">ArgParser</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Attribution-js.html">Attribution</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Button-js.html">Button</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/DragFeature-js.html">DragFeature</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/DragPan-js.html">DragPan</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/DrawFeature-js.html">DrawFeature</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/EditingToolbar-js.html">EditingToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/GetFeature-js.html">GetFeature</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/KeyboardDefaults-js.html">KeyboardDefaults</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/LayerSwitcher-js.html">LayerSwitcher</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Measure-js.html">Measure</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ModifyFeature-js.html">ModifyFeature</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/MouseDefaults-js.html">MouseDefaults</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/MousePosition-js.html">MousePosition</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/MouseToolbar-js.html">MouseToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Navigation-js.html">Navigation</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/NavigationHistory-js.html">NavigationHistory</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/NavToolbar-js.html">NavToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/OverviewMap-js.html">OverviewMap</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Pan-js.html">Pan</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Panel-js.html">Panel</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/PanPanel-js.html">PanPanel</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/PanZoom-js.html">PanZoom</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/PanZoomBar-js.html">PanZoomBar</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Permalink-js.html">Permalink</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Scale-js.html">Scale</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ScaleLine-js.html">ScaleLine</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/SelectFeature-js.html">SelectFeature</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Snapping-js.html">Snapping</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/Split-js.html">Split</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ZoomBox-js.html">ZoomBox</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ZoomIn-js.html">ZoomIn</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ZoomOut-js.html">ZoomOut</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ZoomPanel-js.html">ZoomPanel</a></div></div><div class=MEntry><div class=MFile><a href="../../Control/ZoomToMaxExtent-js.html">ZoomToMaxExtent</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Events-js.html">Events</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Feature</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../../Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="../../Feature/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="../../Feature/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Filter</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../../Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="../../Filter/Comparison-js.html">Comparison</a></div></div><div class=MEntry><div class=MFile><a href="../../Filter/FeatureId-js.html">FeatureId</a></div></div><div class=MEntry><div class=MFile><a href="../../Filter/Logical-js.html">Logical</a></div></div><div class=MEntry><div class=MFile><a href="../../Filter/Spatial-js.html">Spatial</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Format</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="../../Format-js.html">Format</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Filter</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../../Format/Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/Filter/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/Filter/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/Filter/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">GML</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../../Format/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GML/Base-js.html">Base</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GML/v2-js.html">v2</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GML/v3-js.html">v3</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">SLD</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="../../Format/SLD-js.html">SLD</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/SLD/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/SLD/v1_0_0-js.html">v1_0_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">WMC</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="../../Format/WMC-js.html">WMC</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMC/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMC/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMC/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Format</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="../../Format/ArcXML-js.html">ArcXML</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/ArcXML/Features-js.html">ArcXML.<wbr>Features</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GeoJSON-js.html">GeoJSON</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/GPX-js.html">GPX</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/JSON-js.html">JSON</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/KML-js.html">KML</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/OSM-js.html">OSM</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFSCapabilities-js.html">WFSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">WFSCapabilities</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="../../Format/WFSCapabilities/v1-js.html">WFSCapabilities.v1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFSCapabilities/v1_0_0-js.html">WFSCapabilities/<wbr>v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFSCapabilities/v1_1_0-js.html">WFSCapabilities/<wbr>v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFSDescribeFeatureType-js.html">WFSDescribeFeatureType.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">WFST</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="../../Format/WFST-js.html">WFST</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFST/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFST/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WFST/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Format/WKT-js.html">WKT</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSCapabilities-js.html">WMSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">WMSCapabilities</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="../../Format/WMSCapabilities/v1_1-js.html">WMSCapabilities.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSCapabilities/v1_1_0-js.html">WMSCapabilities/<wbr>v1_1_0</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSCapabilities/v1_1_1-js.html">WMSCapabilities/<wbr>v1_1_1</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSDescribeLayer-js.html">WMSDescribeLayer</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSDescribeLayer/v1_1-js.html">WMSDescribeLayer.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="../../Format/XML-js.html">XML</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Geometry</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MFile><a href="../../Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/Collection-js.html">Collection</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/Curve-js.html">Curve</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/LinearRing-js.html">LinearRing</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/LineString-js.html">LineString</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/MultiLineString-js.html">MultiLineString</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/MultiPoint-js.html">MultiPoint</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/MultiPolygon-js.html">MultiPolygon</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="../../Geometry/Rectangle-js.html">Rectangle</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Handler</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="../../Handler-js.html">Handler</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Box-js.html">Box</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Click-js.html">Click</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Drag-js.html">Drag</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Hover-js.html">Hover</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Keyboard-js.html">Keyboard</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/MouseWheel-js.html">MouseWheel</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Path-js.html">Path</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="../../Handler/RegularPolygon-js.html">RegularPolygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Icon-js.html">Icon</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Lang</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MFile><a href="../../Lang-js.html">Lang</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/ca-js.html">ca</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/cs-CZ-js.html">cs-CZ</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/da-DK-js.html">da-DK</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/de-js.html">de</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/en-js.html">en</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/en-CA-js.html">en-CA</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/es-js.html">es</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/fr-js.html">fr</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/it-js.html">it</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/nb-js.html">nb</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/nl-js.html">nl</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/pt-BR-js.html">pt-BR</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/sv-SE-js.html">sv-SE</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/zh-CN-js.html">zh-CN</a></div></div><div class=MEntry><div class=MFile><a href="../../Lang/zh-TW-js.html">zh-TW</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent19')">Layer</a><div class=MGroupContent id=MGroupContent19><div class=MEntry><div class=MFile><a href="../../Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Layer</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MFile><a href="../../Layer/ArcGIS93Rest-js.html">ArcGIS93Rest</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Boxes-js.html">Boxes</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/EventPane-js.html">EventPane</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/FixedZoomLevels-js.html">FixedZoomLevels</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Google-js.html">Google</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Grid-js.html">Grid</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/HTTPRequest-js.html">HTTPRequest</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/KaMap-js.html">KaMap</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/KaMapCache-js.html">KaMapCache</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/MapGuide-js.html">MapGuide</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/MapServer-js.html">MapServer</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/MapServer/Untiled-js.html">MapServer.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Markers-js.html">Markers</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/MultiMap-js.html">MultiMap</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/PointTrack-js.html">PointTrack</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/SphericalMercator-js.html">SphericalMercator</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/TileCache-js.html">TileCache</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/TMS-js.html">TMS</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Vector/RootContainer-js.html">Vector.<wbr>RootContainer</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/VirtualEarth-js.html">VirtualEarth</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/WMS-js.html">WMS</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/WMS/Untiled-js.html">WMS.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/WorldWind-js.html">WorldWind</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/Yahoo-js.html">Yahoo</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/ArcIMS-js.html">ArcIMS</a></div></div><div class=MEntry><div class=MFile><a href="../../Layer/XYZ-js.html">XYZ</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Map-js.html">Map</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent20')">Marker</a><div class=MGroupContent id=MGroupContent20><div class=MEntry><div class=MFile><a href="../../Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="../../Marker/Box-js.html">Box</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent21')">Popup</a><div class=MGroupContent id=MGroupContent21><div class=MEntry><div class=MFile><a href="../../Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MFile><a href="../../Popup/Anchored-js.html">Anchored</a></div></div><div class=MEntry><div class=MFile><a href="../../Popup/AnchoredBubble-js.html">AnchoredBubble</a></div></div><div class=MEntry><div class=MFile><a href="../../Popup/Framed-js.html">Framed</a></div></div><div class=MEntry><div class=MFile><a href="../../Popup/FramedCloud-js.html">FramedCloud</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Projection-js.html">Projection</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent24')">Protocol</a><div class=MGroupContent id=MGroupContent24><div class=MEntry><div class=MFile><a href="../../Protocol-js.html">Protocol</a></div></div><div class=MEntry><div class=MFile><a href="../HTTP-js.html">HTTP</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent22')">SQL</a><div class=MGroupContent id=MGroupContent22><div class=MEntry><div class=MFile><a href="../SQL-js.html">SQL</a></div></div><div class=MEntry><div class=MFile id=MSelected>Gears</div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent23')">WFS</a><div class=MGroupContent id=MGroupContent23><div class=MEntry><div class=MFile><a href="../WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../WFS/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../WFS/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../WFS/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent25')">Renderer</a><div class=MGroupContent id=MGroupContent25><div class=MEntry><div class=MFile><a href="../../Renderer-js.html">Renderer</a></div></div><div class=MEntry><div class=MFile><a href="../../Renderer/Canvas-js.html">Canvas</a></div></div><div class=MEntry><div class=MFile><a href="../../Renderer/Elements-js.html">Elements</a></div></div><div class=MEntry><div class=MFile><a href="../../Renderer/SVG-js.html">SVG</a></div></div><div class=MEntry><div class=MFile><a href="../../Renderer/VML-js.html">VML</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent26')">Request</a><div class=MGroupContent id=MGroupContent26><div class=MEntry><div class=MFile><a href="../../Request-js.html">Request</a></div></div><div class=MEntry><div class=MFile><a href="../../Request/XMLHttpRequest-js.html">XMLHttpRequest</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Rule-js.html">Rule</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent27')">Strategy</a><div class=MGroupContent id=MGroupContent27><div class=MEntry><div class=MFile><a href="../../Strategy-js.html">Strategy</a></div></div><div class=MEntry><div class=MFile><a href="../../Strategy/BBOX-js.html">BBOX</a></div></div><div class=MEntry><div class=MFile><a href="../../Strategy/Cluster-js.html">Cluster</a></div></div><div class=MEntry><div class=MFile><a href="../../Strategy/Fixed-js.html">Fixed</a></div></div><div class=MEntry><div class=MFile><a href="../../Strategy/Paging-js.html">Paging</a></div></div><div class=MEntry><div class=MFile><a href="../../Strategy/Save-js.html">Save</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Style-js.html">Style</a></div></div><div class=MEntry><div class=MFile><a href="../../StyleMap-js.html">StyleMap</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent28')">Tile</a><div class=MGroupContent id=MGroupContent28><div class=MEntry><div class=MFile><a href="../../Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MFile><a href="../../Tile/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="../../Tile/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../Tween-js.html">Tween</a></div></div><div class=MEntry><div class=MFile><a href="../../Util-js.html">Util</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent30')">Index</a><div class=MGroupContent id=MGroupContent30><div class=MEntry><div class=MIndex><a href="../../../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Properties.html">Properties</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../../../../index/Constructor.html">Constructor</a></div></div></div></div></div><script type="text/javascript"><!--
81 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../../../search");
82 --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Constants">Constants</option><option value="Constructor">Constructor</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><script language=JavaScript><!--
83 HideAllBut([22, 24, 29], 31);// --></script></div><!--Menu-->
87 <!--START_ND_TOOLTIPS-->
88 <div class=CToolTip id="tt1"><div class=CClass>A parser to read/write JSON safely. </div></div><div class=CToolTip id="tt2"><div class=CClass>Class for reading and writing Well-Known Text. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>initializeDatabase: function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote>Clean up the protocol.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>supported: function()</td></tr></table></blockquote>Determine whether a browser supports Gears</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>read: function(</td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Read all features from the database and return a OpenLayers.Protocol.Response instance. </div></div><div class=CToolTip id="tt7"><div class=CClass>Protocols return Response objects to their users.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>unfreezeFeature: function(</td><td class=PParameter nowrap>row</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>extractFidFromField: function(</td><td class=PParameter nowrap>field</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>create: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Create new features into the database.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>update: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Construct a request updating modified feature.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>createOrUpdate: function(</td><td class=PParameter nowrap>features</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Construct a request for updating or creating features in the database.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>freezeFeature: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>getFeatureStateForFreeze: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get the state of the feature to store into the database.</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>"delete": function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Delete features from the database.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>createdOffline: function(</td><td class=PParameter nowrap>feature</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns true if the feature had a feature id when it was created in the Gears database, false otherwise; this is determined by checking the form of the feature’s fid value.</div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>commit: function(</td><td class=PParameter nowrap>features,</td></tr><tr><td></td><td class=PParameter nowrap>options</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Go over the features and for each take action based on the feature state. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote>Removes all rows of the table.</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>callUserCallback: function(</td><td class=PParameter nowrap>options,</td></tr><tr><td></td><td class=PParameter nowrap>resp</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.</div></div><div class=CToolTip id="tt20"><div class=CClass>Abstract SQL protocol class. </div></div><div class=CToolTip id="tt21"><div class=CClass>Vector features use the OpenLayers.Geometry classes as geometry description. </div></div><!--END_ND_TOOLTIPS-->
93 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
96 <script language=JavaScript><!--
97 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
projects / syp.git / blob