RetroZilla/extensions/inspector/resources/content/jsutil/rdf/RDFArray.js

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2001
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Joe Hewitt <hewitt@netscape.com> (original author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/***************************************************************
* RDFArray -----------------------------------------------
*  A convenience routine for creating an RDF-based 2d array 
*  indexed by number and hashkey.
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
* REQUIRED IMPORTS:
*   chrome://inspector/content/utils.js
*   chrome://inspector/content/jsutil/xpcom/XPCU.js
*   chrome://inspector/content/jsutil/rdf/RDFU.js
****************************************************************/

//////////// global constants ////////////////////

RDFArray.URI = "http://www.joehewitt.com/mozilla/util/RDFArray#";
RDFArray.RDF_URI = "http://www.w3.org/1999/02/22-rdf-syntax-ns#";
  
///// class RDFArray /////////////////////////

function RDFArray(aNSURI, aRootURN, aArcName)
{
  this.mNSURI = aNSURI;
  this.mRootURN = aRootURN;
  this.mArcName = aArcName ? aArcName : "list";
}

RDFArray.prototype = {
  get datasource() { return this.mDS; },
  get length() { return this.mLength } ,
  
  initialize: function()
  {
    this.mLength = 0;
  
    this.mDS = XPCU.createInstance("@mozilla.org/rdf/datasource;1?name=in-memory-datasource", "nsIRDFDataSource");
  
    var root = gRDF.GetResource(this.mRootURN);
    var res = gRDF.GetAnonymousResource();
    this.mDS.Assert(root, gRDF.GetResource(this.mNSURI+this.mArcName), res, true);
  
    this.mSeq = gRDFCU.MakeSeq(this.mDS, res); 
  },

  add: function(aObject)
  {
    var res = this.createResourceFrom(aObject);
    this.addResource(res);
  },

  addResource: function(aResource)
  {
    this.mSeq.AppendElement(aResource);
    this.mLength++;
  },
  
  insertAt: function(aIndex, aObject)
  {
    var res = this.createResourceFrom(aObject);
    this.insertResourceAt(aIndex, res);
  },

  insertResourceAt: function(aIndex, aResource)
  {
  },

  removeAt: function(aIndex)
  {
    this.mSeq.RemoveElementAt(aIndex+1, true);
    this.mLength--;
  },
  
  removeById: function(aId)
  {
    var proj = gRDF.GetResource(aId);
    proj = XPCU.QI(proj, "nsIRDFNode");
    this.mSeq.RemoveElement(proj, true);
    this.mLength--;
  },
  
  get: function(aIndex, aKey)
  {
    var res = RDFU.getSeqElementAt(this.mSeq, aIndex);
    return RDFU.readAttribute(this.mDS, res, this.mNSURI+aKey);
  },
  
  set: function(aIndex, aKey, aValue)
  {
    var res = RDFU.getSeqElementAt(this.mSeq, aIndex);
    RDFU.writeAttribute(this.mDS, res, this.mNSURI+aKey, aValue);
  },
  
  getResource: function(aIndex)
  {
    return RDFU.getSeqElementAt(this.mSeq, aIndex);
  },

  getResourceId: function(aIndex)
  {
    var el = RDFU.getSeqElementAt(this.mSeq, aIndex);
    return el.Value;
  },

  save: function()
  {
    RDFU.saveDataSource(this.mDS);
  },


  clear: function()
  {
    while (this.mLength) {
      this.mSeq.RemoveElementAt(1, true);
      this.mLength--;
    }
  },

  createResourceFrom: function(aObject)
  {
    var el = gRDF.GetAnonymousResource();

    // add a literal node for each property being added
    for (var name in aObject) {
      this.mDS.Assert(el, gRDF.GetResource(this.mNSURI+name), gRDF.GetLiteral(aObject[name]), true);
    }
    
    return el;
  }

};

/////////// static factory methods /////////////////////////

RDFArray.fromContainer = function(aDS, aResourceID, aNSURI) 
{
  var list = new RDFArray(aNSURI);

  list.mDS = aDS;
  var seq = RDFU.findSeq(aDS, aResourceID);
  list.mSeq = seq;
  list.mLength = seq.GetCount();

  return list;
}

RDFArray.fromContainerArc = function(aDS, aSourceId, aTargetId, aNSURI) 
{
  var list = new RDFArray(aNSURI);
  list.mDS = aDS;

  var source = gRDF.GetResource(aSourceId);
  var target = gRDF.GetResource(aTargetId);
  var seqRes = aDS.GetTarget(source, target, true);

  var seq = RDFU.makeSeq(aDS, seqRes);
  list.mSeq = seq;
  list.mLength = seq.GetCount();

  return list;
}