File: hyperobject.html

package info (click to toggle)
cl-hyperobject 2.11.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 300 kB
  • ctags: 224
  • sloc: lisp: 1,820; xml: 215; makefile: 161; sh: 28
file content (3 lines) | stat: -rw-r--r-- 2,664 bytes parent folder | download | duplicates (5) 
1
2
3
 
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Hyperobject Documentation</title><meta content="Kevin M. Rosenberg (C) 2002" name="Copyright"></meta><meta content="Kevin M. Rosenberg" name="Author"></meta><link type="text/css" href="http://b9.com/main.css" rel="stylesheet"></link></head><body><h1>Hyperobject Documentation</h1><h2>Overview</h2><p><span class="pkgbody">Hyperobject</span> is an Common Lisp object representation library based on the Metaobject Protocol.</p><h2>Reference</h2><h3>Class options</h3><table><tbody><tr><td><b>sql-name</b></td><td>Overrides default name of SQL table.</td></tr><tr><td><b>version</b></td><td>Sets the version number of the class. Can be used to convert previous version of the class.</td></tr><tr><td><b>instanciable</b></td><td>If NIL, the class can not be instanciated by the user.</td></tr><tr><td><b>description</b></td><td>The class description.</td></tr></tbody></table><h3>Slot options</h3><table><tbody><tr><td><b>sql-name</b></td><td>Override name of the SQL column</td></tr><tr><td><b>unique</b></td><td>The values in the slot must be unique</td></tr><tr><td><b>stored</b></td><td>The values in the slot are stored in the database.</td></tr><tr><td><b>indexed</b></td><td>The values of the slot are indexed in the database.</td></tr><tr><td><b>nil-text</b></td><td>The text to print if the slot is NIL</td></tr><tr><td><b>value-type</b></td><td>Sets the data type for the field. See the next section for complete details</td></tr><tr><td><b>inverse</b></td><td>Sets the name of an automatically generated lookup function based on a key value for this slot</td></tr></tbody></table><h3>Type field</h3><p>Valid types for a <span class="pkgbody">hyperobject</span>slot along with their coresponding SQL types are listed in the below table.</p><table class="font-family:courier"><tr><td>string</td><td>TEXT</td></tr><tr><td><div>(string <i>n</i>)</div><div>(varchar <i>n</i>)</div></td><td>VARCHAR(n)</td></tr><tr><td>(char <i>n</i>)</td><td>CHAR(n)</td></tr><tr><td>character</td><td>CHAR(1)</td></tr><tr><td><div>float</div><div>single-float</div></td><td>float</td></tr><tr><td>double-float</td><td>double</td></tr><tr><td>blob</td><td>BLOB</td></tr></table><h2>Subobject field</h2><p>This field sets up the storage of a slot of hold a cached object or list of objects. A lookup function and the keys to the function are also specified.</p><p>The format for the subobject field is:</p><p>(<lookup function> keys*)</p></body></html>