more docs

Author: kevinchekovfeeney

lib/woql.js

@@ -1,4 +1,3 @@
-
 const UTILS = require('./utils');
 const WOQLRule = require('./woqlRule');
 const FrameRule = require('./frameRule');
@@ -505,6 +504,7 @@ WOQL.boxClasses = function(prefix, classes, except, graph){	return new WOQLQuery
 
 WOQL.libs = function(...libs){ return new WOQLQuery().libs(...libs)}
 
+WOQL.generateChoiceList = function(cls, clslabel, clsdesc, choices, graph, parent){ return new WOQLQuery().generateChoiceList(cls, clslabel, clsdesc, choices, graph, parent)}
 
 /**
  * Deletes the Class with the passed ID form the schema (and all references to it)
@@ -1274,20 +1274,18 @@ WOQLQuery.prototype.delete_property = function(p, graph){
 WOQLQuery.prototype.boxClasses = function(prefix, classes, except, graph){	
 	graph = (graph ? this.cleanGraph(graph) : "db:schema");
 	prefix = prefix || "scm:";
-	var subs = [
-        WOQL.quad("v:Cid", "rdf:type", "owl:Class", graph),
-		WOQL.not().abstract("v:Cid", graph),
-	];
+	var subs = [];
 	for(var i = 0; i<classes.length; i++){
 		subs.push(WOQL.sub("v:Cid", this.cleanClass(classes[i])));
 	}
+	var nsubs = [];
 	for(var i = 0; i<except.length; i++){
-		subs.push(WOQL.not().sub("v:Cid", this.cleanClass(except[i])));
+		nsubs.push(WOQL.not().sub("v:Cid", this.cleanClass(except[i])));
 	}
 	//property punning
 	//generate a property id that is the same as the classname but starting with a lowercase letter
 	let idgens = [
-		WOQL.re(".*#(.)(.*)", "v:Cid", ["v:AllB", "v:FirstB", "v:RestB"]),
+		WOQL.re("#(.)(.*)", "v:Cid", ["v:AllB", "v:FirstB", "v:RestB"]),
         WOQL.lower("v:FirstB", "v:Lower"),
         WOQL.concat(["v:Lower", "v:RestB"], "v:Propname"),
         WOQL.concat(["Scoped", "v:FirstB", "v:RestB"], "v:Cname"),
@@ -1296,7 +1294,10 @@ WOQLQuery.prototype.boxClasses = function(prefix, classes, except, graph){
 	];
 
     const filter = WOQL.and(
+		WOQL.quad("v:Cid", "rdf:type", "owl:Class", graph),
+		WOQL.not().abstract("v:Cid", graph),
 		WOQL.or(...subs),
+		WOQL.and(...nsubs),
 		WOQL.and(...idgens),
         WOQL.quad("v:Cid", "rdfs:label", "v:Label", graph),
 		WOQL.quad("v:Cid", "rdfs:comment", "v:Desc", graph)
@@ -1312,12 +1313,50 @@ WOQLQuery.prototype.boxClasses = function(prefix, classes, except, graph){
     ));
 }
 
+WOQLQuery.prototype.generateChoiceList = function(cls, clslabel, clsdesc, choices, graph, parent){
+    parent = parent || "scm:Enumerated";
+    graph = graph || "db:schema";
+    var confs = [
+        WOQL.add_class(cls, graph)
+            .label(clslabel)
+            .description(clsdesc)
+            .parent(parent)
+    ]; 
+    for(var i = 0; i<choices.length; i++){
+        if(!choices[i]) continue;
+        confs.push(WOQL.insert(choices[i][0], cls, graph)
+            .label(choices[i][1])
+            .description(choices[i][2])
+        )
+    }
+    //generate one of list
+    var clist = [];
+    var listid = "_:" + cls.split(":")[1];
+    var lastid = listid;
+    for(var i = 0; i <= choices.length; i++){
+        if(!choices[i]) continue;
+        var nextid = (i < (choices.length -1) ? listid + "_" + i : "rdf:nil");
+        clist.push( WOQL.add_quad(lastid, "rdf:first", choices[i][0], graph))
+        clist.push( WOQL.add_quad(lastid, "rdf:rest", nextid, graph));
+        lastid = nextid;
+    }
+    //do the owl oneof
+    let oneof = WOQL.and(
+        WOQL.add_quad(cls, "owl:oneOf", listid, graph),
+        ...clist
+    )
+    return WOQL.and(...confs, oneof);
+}
+
+
 WOQLQuery.prototype.libs = function(...libs){
 	var bits = [];
 	if(libs.indexOf("xdd") != -1){
 		bits.push(this.loadXDD());
-		if(libs.indexOf("box") != -1) bits.push(this.loadXDDBoxes());
-
+		if(libs.indexOf("box") != -1) {
+			bits.push(this.loadXDDBoxes());
+			bits.push(this.loadXSDBoxes());
+		}
 	}
 	else if(libs.indexOf("box") != -1){
 		bits.push(this.loadXSDBoxes());
@@ -1402,9 +1441,9 @@ WOQLQuery.prototype.loadXSDBoxes = function(){
 		this.boxDatatype("xsd:ID", "ID", "An xsd:ID value."),
 		this.boxDatatype("xsd:IDREF", "IDREF", "An xsd:IDREF value."),
 		this.boxDatatype("xsd:ENTITY", "ENTITY", "An xsd:ENTITY value."),
-		this.boxDatatype("xsd:XMLLiteral", "XML Literal", "An rdf:XMLLiteral value."),
-		this.boxDatatype("xsd:PlainLiteral", "Plain Literal", "An rdf:PlainLiteral value."),
-		this.boxDatatype("rdfs:Literal", "Literal", "An rdfs:Literal value.")	
+		//this.boxDatatype("rdf:XMLLiteral", "XML Literal", "An rdf:XMLLiteral value."),
+		//this.boxDatatype("rdf:PlainLiteral", "Plain Literal", "An rdf:PlainLiteral value."),
+		//this.boxDatatype("rdfs:Literal", "Literal", "An rdfs:Literal value.")	
 	)
 }
 
@@ -1439,9 +1478,9 @@ WOQLQuery.prototype.boxDatatype = function(datatype, label, descr, graph, prefix
 	let ext = datatype.split(":")[1];
 	let box_class_id = prefix + ext.charAt(0).toUpperCase() + ext.slice(1);
 	let box_prop_id = prefix + ext.charAt(0).toLowerCase() + ext.slice(1);
-	var box_class = WOQL.insert(box_class_id, "owl:Class", graph).label(label).parent("scm:Box");
+	var box_class = WOQL.add_class(box_class_id).label(label).parent("scm:Box");
 	if(descr) box_class.description(descr);
-	var box_prop = WOQL.insert(box_prop_id, datatype, graph).label(label);
+	var box_prop = WOQL.add_property(box_prop_id, datatype).label(label).domain(box_class_id)
 	if(descr) box_prop.description(descr);
 	return WOQL.and(box_class, box_prop);
 }
@@ -1876,12 +1915,12 @@ WOQLQuery.prototype.execute = function(client){
 			if(typeof this.query['@context'][pref] == "undefined")
 			this.query['@context'][pref] = UTILS.standard_urls[pref];
 		}
+		this.query["@context"]["_"] = "_:";		
 		var json = this.json();
 	}
 	else {
 		var json = this.json();
 	}
-	this.query["@context"]["_"] = "_:";		
 	if(this.contains_update){
 		return client.select(false, json);
 		//return client.update(false, json);