X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-oodml.xml;fp=doc%2Fref-oodml.xml;h=f068a5d123217e9a9bdb5ce6e535233783ff863e;hb=5248ae9f94d2022596ef8846e0581ea716607a84;hp=0000000000000000000000000000000000000000;hpb=23a10375f83c89c138369e05c8f57f679bb43ec9;p=clsql.git diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml new file mode 100644 index 0000000..f068a5d --- /dev/null +++ b/doc/ref-oodml.xml @@ -0,0 +1,668 @@ + + +%myents; +]> + + + + Object Oriented Data Manipulation Language (OODML) + + + + + + + + + *DB-AUTO-SYNC* + + Variable + + + Value Type + + + + + + Initial Value + nil + + + Description + + + + Examples + + + + + + Affected By + None. + + + See Also + None. + + + Notes + None. + + + + + + *DEFAULT-UPDATE-OBJECTS-MAX-LEN* + + Variable + + + Value Type + + + + + + Initial Value + nil + + + Description + + + + Examples + + + + + + Affected By + None. + + + See Also + None. + + + Notes + None. + + + + + + DELETE-INSTANCE-RECORDS + + Function + + + Syntax + + (DELETE-INSTANCE-RECORDS OBJECT) [generic] => + + + Arguments and Values + + + + + + Description + Deletes the records represented by OBJECT in the + appropriate table of the database associated with OBJECT. If + OBJECT is not yet associated with a database, an error is + signalled. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + INSTANCE-REFRESHED + + Function + + + Syntax + + (INSTANCE-REFRESHED OBJECT) [generic] => + + + Arguments and Values + + + + + + Description + Provides a hook which is called within an object + oriented call to SELECT with a non-nil value of REFRESH when + the View Class instance OBJECT has been updated from the + database. A method specialised on STANDARD-DB-OBJECT is + provided which has no effects. Methods specialised on + particular View Classes can be used to specify any operations + that need to be made on View Classes instances which have been + updated in calls to SELECT. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + UPDATE-INSTANCE-FROM-RECORDS + + Function + + + Syntax + + (UPDATE-INSTANCE-FROM-RECORDS OBJECT &KEY DATABASE) [generic] => + + + Arguments and Values + + + + + + Description + Updates the slot values of the View Class instance + OBJECT using the attribute values of the appropriate table of + DATABASE which defaults to the database associated with OBJECT + or, if OBJECT is not associated with a database, + *DEFAULT-DATABASE*. Join slots are updated but instances of + the class on which the join is made are not updated. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + UPDATE-OBJECTS-JOINS + + Function + + + Syntax + + (UPDATE-OBJECTS-JOINS OBJECTS &KEY (SLOTS T) (FORCE-P T) CLASS-NAME (MAX-LEN *DEFAULT-UPDATE-OBJECTS-MAX-LEN*)) [function] => + + + Arguments and Values + + + + + + Description + Updates from the records of the appropriate + database tables the join slots specified by SLOTS in + the supplied list of View Class instances OBJECTS. + SLOTS is t by default which means that all join slots + with :retrieval :immediate are updated. CLASS-NAME is + used to specify the View Class of all instance in + OBJECTS and default to nil which means that the class + of the first instance in OBJECTS is used. FORCE-P is t + by default which means that all join slots are updated + whereas a value of nil means that only unbound join + slots are updated. MAX-LEN defaults to + *DEFAULT-UPDATE-OBJECTS-MAX-LEN* and when non-nil + specifies that UPDATE-OBJECT-JOINS may issue multiple + database queries with a maximum of MAX-LEN instances + updated in each query. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + UPDATE-RECORD-FROM-SLOT + + Function + + + Syntax + + (UPDATE-RECORD-FROM-SLOT OBJECT SLOT &KEY DATABASE) [generic] => + + + Arguments and Values + + + + + + Description + Updates the value stored in the column represented by + the slot, specified by the CLOS slot name SLOT, of View Class + instance OBJECT. DATABASE defaults to *DEFAULT-DATABASE* and + specifies the database in which the update is made only if + OBJECT is not associated with a database. In this case, a + record is created in DATABASE and the attribute represented by + SLOT is initialised from the value of the supplied slots with + other attributes having default values. Furthermore, OBJECT + becomes associated with DATABASE. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + UPDATE-RECORD-FROM-SLOTS + + Function + + + Syntax + + (UPDATE-RECORD-FROM-SLOTS OBJECT SLOTS &KEY DATABASE) [generic] => + + + Arguments and Values + + + + + + Description + Updates the values stored in the columns represented by + the slots, specified by the CLOS slot names SLOTS, of View + Class instance OBJECT. DATABASE defaults to *DEFAULT-DATABASE* + and specifies the database in which the update is made only if + OBJECT is not associated with a database. In this case, a + record is created in the appropriate table of DATABASE and the + attributes represented by SLOTS are initialised from the + values of the supplied slots with other attributes having + default values. Furthermore, OBJECT becomes associated with + DATABASE. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + + UPDATE-RECORDS-FROM-INSTANCE + + Function + + + Syntax + + (UPDATE-RECORDS-FROM-INSTANCE OBJECT &KEY DATABASE) [generic] => + + + Arguments and Values + + + + + + Description + Using an instance of a View Class, OBJECT, update the + table that stores its instance data. DATABASE defaults to + *DEFAULT-DATABASE* and specifies the database in which the + update is made only if OBJECT is not associated with a + database. In this case, a record is created in the appropriate + table of DATABASE using values from the slot values of OBJECT, + and OBJECT becomes associated with DATABASE. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + + + + UPDATE-SLOT-FROM-RECORD + + Function + + + Syntax + + (UPDATE-SLOT-FROM-RECORD OBJECT SLOT &KEY DATABASE) [generic] => + + + Arguments and Values + + + + + + Description + Updates the slot value, specified by the CLOS slot name + SLOT, of the View Class instance OBJECT using the attribute + values of the appropriate table of DATABASE which defaults to + the database associated with OBJECT or, if OBJECT is not + associated with a database, *DEFAULT-DATABASE*. Join slots + are updated but instances of the class on which the join is + made are not updated. + + + + Examples + + + + + + Side Effects + + + + + + Affected by + + + + + + + + Exceptional Situations + + + + + + See Also + + + + + + + + Notes + + + + + + +