Update of /project/elephant/cvsroot/elephant/src/elephant In directory clnet:/tmp/cvs-serv16270/elephant
Modified Files: classindex.lisp controller.lisp metaclasses.lisp package.lisp Log Message: Initial edits for new user manual
--- /project/elephant/cvsroot/elephant/src/elephant/classindex.lisp 2007/03/21 14:29:30 1.30 +++ /project/elephant/cvsroot/elephant/src/elephant/classindex.lisp 2007/03/23 16:08:10 1.31 @@ -384,10 +384,18 @@ ;; USER SET API ;; =================
-(defgeneric get-instances-by-class (persistent-metaclass)) -(defgeneric get-instance-by-value (persistent-metaclass slot-name value)) -(defgeneric get-instances-by-value (persistent-metaclass slot-name value)) -(defgeneric get-instances-by-range (persistent-metaclass slot-name start end)) +(defgeneric get-instances-by-class (persistent-metaclass) + (:documentation "Retrieve all instances from the class index as a list of objects")) +(defgeneric get-instance-by-value (persistent-metaclass slot-name value) + (:documentation "Retrieve instances from a slot index by value. Will return only the first + instance if there are duplicates.")) +(defgeneric get-instances-by-value (persistent-metaclass slot-name value) + (:documentation "Returns a list of all instances where the slot value is equal to value.")) +(defgeneric get-instances-by-range (persistent-metaclass slot-name start end) + (:documentation "Returns a list of all instances that match + values between start and end. An argument of + nil to start or end indicates, respectively, + the lowest or highest value in the index"))
(defmethod get-instances-by-class ((class symbol)) (get-instances-by-class (find-class class))) --- /project/elephant/cvsroot/elephant/src/elephant/controller.lisp 2007/02/26 19:12:18 1.39 +++ /project/elephant/cvsroot/elephant/src/elephant/controller.lisp 2007/03/23 16:08:10 1.40 @@ -434,7 +434,7 @@ (get-value key (controller-root store-controller)))
(defun root-existsp (key &key (store-controller *store-controller*)) - "Get a something from the root." + "Test whether a key exists in the root" (declare (type store-controller store-controller)) (if (existsp key (controller-root store-controller)) t --- /project/elephant/cvsroot/elephant/src/elephant/metaclasses.lisp 2007/03/21 14:29:30 1.12 +++ /project/elephant/cvsroot/elephant/src/elephant/metaclasses.lisp 2007/03/23 16:08:10 1.13 @@ -43,6 +43,8 @@ ;;
(defmacro defpclass (cname parents slot-defs &rest class-opts) + "Shorthand for defining persistent objects. Wraps the main + class definition with persistent-metaclass" `(defclass ,cname ,parents ,slot-defs ,@(add-persistent-metaclass-argument class-opts))) --- /project/elephant/cvsroot/elephant/src/elephant/package.lisp 2007/03/19 19:41:35 1.24 +++ /project/elephant/cvsroot/elephant/src/elephant/package.lisp 2007/03/23 16:08:10 1.25 @@ -32,10 +32,10 @@ #:store-controller #:controller-root #:controller-class-root #:open-store #:close-store #:with-open-store #:add-to-root #:get-from-root #:remove-from-root #:root-existsp - #:get-cached-instance #:flush-instance-cache + #:map-root #:get-cached-instance #:flush-instance-cache #:controller-symbol-cache #:controller-symbol-id-cache #:controller-fast-symbols-p - #:optimize-layout + #:optimize-layout #:drop-pobject #:get-user-configuration-parameter #:database-version
@@ -51,7 +51,7 @@ #:initialize-serializer
#:with-transaction #:ensure-transaction - #:start-ele-transaction #:commit-transaction #:abort-transaction + #:start-ele-transaction #:commit-transaction #:abort-transaction
#:persistent #:persistent-object #:persistent-metaclass #:persistent-collection #:defpclass