dojo.provide("dojox.data.HtmlStore"); dojo.require("dojox.xml.parser"); dojo.require("dojo.data.util.simpleFetch"); dojo.require("dojo.data.util.filter"); dojo.declare("dojox.data.HtmlStore", null, { constructor: function(/*Object*/args){ // summary: // Initializer for the HTML table store. // description: // The HtmlStore can be created in one of two ways: a) by parsing an existing // table or list DOM node on the current page or b) by referencing an external url and giving // the id of the table or listin that page. The remote url will be parsed as an html page. // // The HTML table or list should be of the following form: // // | // | // | // | // | // | // | // | // | // | // | // | // | // | // | // | // | // |
Attribute1Attribute2
Value1.1Value1.2
Value2.1Value2.2
// // -or- // // | // // -or- // // |
    // |
  1. Value.1
  2. // |
  3. Value.2
  4. // |
// // args: // An anonymous object to initialize properties. It expects the following values: // dataId: The id of the HTML table to use. // OR // url: The url of the remote page to load // dataId: The id of the table element in the remote page if(args.url){ if(!args.dataId) throw new Error("dojo.data.HtmlStore: Cannot instantiate using url without an id!"); this.url = args.url; this.dataId = args.dataId; }else{ if(args.dataId){ this._rootNode = dojo.byId(args.dataId); this.dataId = this._rootNode.id; }else{ this._rootNode = dojo.byId(this.dataId); } this._indexItems(); } }, url: "", // So the parser can instantiate the store via markup. dataId: "", // So the parser can instantiate the store via markup. _indexItems: function(){ this._getHeadings(); if (this._rootNode.rows){//tables if(this._rootNode.tBodies && this._rootNode.tBodies.length > 0) { this._rootNode = this._rootNode.tBodies[0]; } var i; for(i=0; i 0)?values[0]:defaultValue; //Object || int || Boolean }, getValues: function(/* item */ item, /* attribute-name-string */ attribute){ // summary: // See dojo.data.api.Read.getValues() this._assertIsItem(item); var index = this._assertIsAttribute(attribute); if(index>-1){ if (item.cells){ return [dojox.xml.parser.textContent(item.cells[index])]; }else{//return Value for lists return [dojox.xml.parser.textContent(item)]; } } return []; //Array }, getAttributes: function(/* item */ item){ // summary: // See dojo.data.api.Read.getAttributes() this._assertIsItem(item); var attributes = []; for(var i=0; i 0; }, containsValue: function(/* item */ item, /* attribute-name-string */ attribute, /* anything */ value){ // summary: // See dojo.data.api.Read.containsValue() var regexp = undefined; if(typeof value === "string"){ regexp = dojo.data.util.filter.patternToRegExp(value, false); } return this._containsValue(item, attribute, value, regexp); //boolean. }, _containsValue: function( /* item */ item, /* attribute-name-string */ attribute, /* anything */ value, /* RegExp?*/ regexp){ // summary: // Internal function for looking at the values contained by the item. // description: // Internal function for looking at the values contained by the item. This // function allows for denoting if the comparison should be case sensitive for // strings or not (for handling filtering cases where string case should not matter) // // item: // The data item to examine for attribute values. // attribute: // The attribute to inspect. // value: // The value to match. // regexp: // Optional regular expression generated off value if value was of string type to handle wildcarding. // If present and attribute values are string, then it can be used for comparison instead of 'value' var values = this.getValues(item, attribute); for(var i = 0; i < values.length; ++i){ var possibleValue = values[i]; if(typeof possibleValue === "string" && regexp){ return (possibleValue.match(regexp) !== null); }else{ //Non-string matching. if(value === possibleValue){ return true; // Boolean } } } return false; // Boolean }, isItem: function(/* anything */ something){ // summary: // See dojo.data.api.Read.isItem() if(something && something.store && something.store === this){ return true; //boolean } return false; //boolean }, isItemLoaded: function(/* anything */ something){ // summary: // See dojo.data.api.Read.isItemLoaded() return this.isItem(something); }, loadItem: function(/* Object */ keywordArgs){ // summary: // See dojo.data.api.Read.loadItem() this._assertIsItem(keywordArgs.item); }, _fetchItems: function(request, fetchHandler, errorHandler){ // summary: // Fetch items (XML elements) that match to a query // description: // If '_fetchUrl' is specified, it is used to load an XML document // with a query string. // Otherwise and if 'url' is specified, the XML document is // loaded and list XML elements that match to a query (set of element // names and their text attribute values that the items to contain). // A wildcard, "*" can be used to query values to match all // occurrences. // If '_rootItem' is specified, it is used to fetch items. // request: // A request object // fetchHandler: // A function to call for fetched items // errorHandler: // A function to call on error if(this._rootNode){ this._finishFetchItems(request, fetchHandler, errorHandler); }else{ if(!this.url){ this._rootNode = dojo.byId(this.dataId); }else{ var getArgs = { url: this.url, handleAs: "text" }; var self = this; var getHandler = dojo.xhrGet(getArgs); getHandler.addCallback(function(data){ var findNode = function(node, id){ if(node.id == id){ return node; //object } if(node.childNodes){ for(var i=0; i 0){ items = arrayOfAllItems.slice(0,arrayOfAllItems.length); } fetchHandler(items, request); } }, getFeatures: function(){ // summary: // See dojo.data.api.Read.getFeatures() return { 'dojo.data.api.Read': true, 'dojo.data.api.Identity': true }; }, close: function(/*dojo.data.api.Request || keywordArgs || null */ request){ // summary: // See dojo.data.api.Read.close() // nothing to do here! }, getLabel: function(/* item */ item){ // summary: // See dojo.data.api.Read.getLabel() if(this.isItem(item)){ if(item.cells){ return "Item #" + this.getIdentity(item); }else{ return this.getValue(item,"name"); } } return undefined; }, getLabelAttributes: function(/* item */ item){ // summary: // See dojo.data.api.Read.getLabelAttributes() if(item.cells){ return null; }else{ return ["name"]; } }, /*************************************** dojo.data.api.Identity API ***************************************/ getIdentity: function(/* item */ item){ // summary: // See dojo.data.api.Identity.getIdentity() this._assertIsItem(item); if(this.hasAttribute(item, "name")){ return this.getValue(item,"name"); }else{ return item._ident; } }, getIdentityAttributes: function(/* item */ item){ // summary: // See dojo.data.api.Identity.getIdentityAttributes() //Identity isn't taken from a public attribute. return null; }, fetchItemByIdentity: function(keywordArgs){ // summary: // See dojo.data.api.Identity.fetchItemByIdentity() var identity = keywordArgs.identity; var self = this; var item = null; var scope = null; if(!this._rootNode){ if(!this.url){ this._rootNode = dojo.byId(this.dataId); this._indexItems(); if(self._rootNode.rows){ //Table item = this._rootNode.rows[identity + 1]; }else{ //Lists for(var i = 0; i < self._rootNode.childNodes.length; i++){ if(self._rootNode.childNodes[i].nodeType === 1 && identity === dojox.xml.parser.textContent(self._rootNode.childNodes[i])) { item = self._rootNode.childNodes[i]; } } } if(keywordArgs.onItem){ scope = keywordArgs.scope?keywordArgs.scope:dojo.global; keywordArgs.onItem.call(scope, item); } }else{ var getArgs = { url: this.url, handleAs: "text" }; var getHandler = dojo.xhrGet(getArgs); getHandler.addCallback(function(data){ var findNode = function(node, id){ if(node.id == id){ return node; //object } if(node.childNodes){ for(var i=0; i