Common Lisp Package: BKNR.INDICES

README:

FUNCTION

Public

INDEX-CREATE (CLASS-NAME &REST INITARGS)

Instantiate the index object with class CLASS-NAME with INITARGS.

Undocumented

PARENT-CATEGORIES (CATEGORY)

PARENT-CATEGORY (CATEGORY)

TREE-CATEGORIES (TREE &OPTIONAL CATEGORY)

TREE-FIND-CHILDREN (TREE CATEGORY)

TREE-FIND-SIBLINGS (TREE CATEGORY)

Private

CATEGORY-TREE-ROOT-NODE (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CATEGORY-TREE-TEST (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

INDEX-HOLDER-CLASS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

INDEX-HOLDER-INDEX (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

INDEX-HOLDER-INDEX-SUBCLASSES (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

INDEX-HOLDER-NAME (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

INDEX-HOLDER-SLOTS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

Undocumented

CATEGORY-NAME (CATEGORY)

CATEGORY-TO-NODE (CATEGORY)

CATEGORY-TREE-P (OBJECT)

SETFCATEGORY-TREE-ROOT-NODE (NEW-VALUE INSTANCE)

SETFCATEGORY-TREE-TEST (NEW-VALUE INSTANCE)

COPY-CATEGORY-TREE (INSTANCE)

COPY-INDEX-HOLDER (INSTANCE)

COPY-SKIP-LIST (SKIP-LIST)

CREATE-INDEX-ACCESS-FUNCTIONS (INDEX &KEY INDEX-READER INDEX-VALUES INDEX-MAPVALUES INDEX-KEYS INDEX-VAR)

DEFUN-AND-COMPILE (DEFUN)

SETFINDEX-HOLDER-CLASS (NEW-VALUE INSTANCE)

SETFINDEX-HOLDER-INDEX (NEW-VALUE INSTANCE)

SETFINDEX-HOLDER-INDEX-SUBCLASSES (NEW-VALUE INSTANCE)

SETFINDEX-HOLDER-NAME (NEW-VALUE INSTANCE)

INDEX-HOLDER-P (OBJECT)

SETFINDEX-HOLDER-SLOTS (NEW-VALUE INSTANCE)

MAKE-CATEGORY-TREE (&KEY ((TEST DUM19) #'EQL) ((ROOT-NODE DUM20) (MAKE-NODE ROOT NIL)))

MAKE-INDEX-HOLDER (&KEY ((CLASS DUM0) NIL) ((SLOTS DUM1) NIL) ((NAME DUM2) NIL) ((INDEX DUM3) NIL) ((INDEX-SUBCLASSES DUM4) NIL))

MAKE-INDEX-OBJECT (&KEY INDEX TYPE INITARGS READER VALUES MAPVALUES SLOTS KEYS VAR)

MAKE-NODE (NAME CHILDREN)

NODE-CHILDREN (NODE)

SETFNODE-CHILDREN (NEW-VALUE NODE)

NODE-CHILDREN-EMPTY-P (NODE)

NODE-NAME (NODE)

SETFNODE-NAME (NEW-VALUE NODE)

NODE-TO-CATEGORIES (NODE &OPTIONAL PARENT-CATEGORY)

NODES-TO-CATEGORIES (NODES &OPTIONAL PARENT-CATEGORY)

TREE-ADD-CATEGORY (TREE CATEGORY)

TREE-FIND-NODE (TREE CATEGORY)

TREE-REMOVE-CATEGORY (TREE CATEGORY)

VALIDATE-INDEX-DECLARATION (CLASS INDICES)

GENERIC-FUNCTION

Public

DESTROY-OBJECT (OBJECT)

Destroy the given object, and delete it from the indices.

INDEX-ADD (INDEX OBJECT)

Add OBJECT to the INDEX. Throws an ERROR if a problem happened while inserting OBJECT.

INDEX-CLEAR (INDEX)

Remove all indexed objects from the index.

INDEX-GET (INDEX KEY)

Get the object (or the objects) stored under the index-key KEY.

INDEX-KEYS (INDEX)

Returns all the KEYs of the INDEX.

INDEX-MAPVALUES (INDEX FUN)

Apply FUN to every object in the INDEX.

INDEX-REINITIALIZE (NEW-INDEX OLD-INDEX)

Called when the definition of an index is changed.

INDEX-REMOVE (INDEX OBJECT)

Remove OBJECT from the INDEX.

INDEX-VALUES (INDEX)

Returns all the objects (or object lists) stored in INDEX.

Undocumented

CLASS-SLOT-INDEX (CLASS SLOT-NAME)

CLASS-SLOT-INDICES (CLASS SLOT-NAME)

CLEAR-CLASS-INDICES (CLASS)

CLEAR-SLOT-INDICES (SLOT)

INDEXED-CLASS-INDEX-NAMED (CLASS INDEX-NAME)

OBJECT-DESTROYED-P (OBJECT)

Private

CURSOR-NEXT (CURSOR &OPTIONAL EOC)

Return the current value and advance the cursor. Returns EOC if the cursor is at its end.

CURSOR-PREVIOUS (CURSOR &OPTIONAL EOC)

Return the current value and advance the cursor. Returns EOC if the cursor is at its end.

INDEX-KEYS-CURSOR (INDEX)

Returns a cursor that walks all the keys stored in INDEX.

INDEX-VALUES-CURSOR (INDEX)

Returns a cursor that walks all the objects stored in INDEX.

Undocumented

CLASS-ALL-INDEXED-SUPERCLASSES (CLASS)

COMPUTE-CLASS-INDICES (CLASS CLASS-INDICES)

CONDITION-INDEX (CONDITION)

CONDITION-KEY (CONDITION)

CONDITION-VALUE (CONDITION)

CURSOR-PREV (SLC &OPTIONAL EOC)

DESTROY-OBJECT-WITH-CLASS (CLASS OBJECT)

REINITIALIZE-CLASS-INDICES (CLASS)

SLOT-ACCESSOR

Private

INDEX-DIRECT-SLOT-DEFINITION-INDEX (OBJECT)

Slot keyword for an already existing index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-INITARGS (OBJECT)

Arguments that will be passed to INDEX-CREATE when creating a new slot index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-KEYS (OBJECT)

Name of a function that will be created to get the keys stored in the index

SETFINDEX-DIRECT-SLOT-DEFINITION-INDEX-KEYS (NEW-VALUE OBJECT)

Name of a function that will be created to get the keys stored in the index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-MAPVALUES (OBJECT)

Name of a function that will be created to map over the values stored in the index

SETFINDEX-DIRECT-SLOT-DEFINITION-INDEX-MAPVALUES (NEW-VALUE OBJECT)

Name of a function that will be created to map over the values stored in the index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-READER (OBJECT)

Name of a function that will be created to query the slot index

SETFINDEX-DIRECT-SLOT-DEFINITION-INDEX-READER (NEW-VALUE OBJECT)

Name of a function that will be created to query the slot index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-SUBCLASSES (OBJECT)

Specify if the slot index will also index subclasses of the class to which the slot belongs, default is T

SETFINDEX-DIRECT-SLOT-DEFINITION-INDEX-SUBCLASSES (NEW-VALUE OBJECT)

Specify if the slot index will also index subclasses of the class to which the slot belongs, default is T

INDEX-DIRECT-SLOT-DEFINITION-INDEX-TYPE (OBJECT)

Slot keyword to specify the class of a new slot index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-VALUES (OBJECT)

Name of a function that will be created to get the values stored in the index

SETFINDEX-DIRECT-SLOT-DEFINITION-INDEX-VALUES (NEW-VALUE OBJECT)

Name of a function that will be created to get the values stored in the index

INDEX-DIRECT-SLOT-DEFINITION-INDEX-VAR (OBJECT)

Symbol that will be bound to the index

SLOT-INDEX-HASH-TABLE (OBJECT)

The internal hash table used to index objects.

SETFSLOT-INDEX-HASH-TABLE (NEW-VALUE OBJECT)

The internal hash table used to index objects.

SLOT-INDEX-INDEX-NIL (OBJECT)

If T, NIL is used as a valid slot value, else slots with NIL value are treated as unbound slots.

SLOT-INDEX-SLOT-NAME (OBJECT)

The value of the slot with name SLOT-NAME is used as a key to the internal hash-table.

Undocumented

ARRAY-INDEX-ARRAY (OBJECT)

SETFARRAY-INDEX-ARRAY (NEW-VALUE OBJECT)

ARRAY-INDEX-SLOT-NAMES (OBJECT)

SETFARRAY-INDEX-SLOT-NAMES (NEW-VALUE OBJECT)

CATEGORY-INDEX-TREE (OBJECT)

SETFCATEGORY-INDEX-TREE (NEW-VALUE OBJECT)

CLASS-INDEX-INDEX-SUPERCLASSES (OBJECT)

CLASS-SKIP-INDEX-HASH-TABLE (OBJECT)

SETFCLASS-SKIP-INDEX-HASH-TABLE (NEW-VALUE OBJECT)

CLASS-SKIP-INDEX-INDEX-SUPERCLASSES (OBJECT)

CLASS-SKIP-INDEX-SLOT-NAME (OBJECT)

SETFCLASS-SKIP-INDEX-SLOT-NAME (NEW-VALUE OBJECT)

INDEX-DIRECT-SLOT-DEFINITION-CLASS (OBJECT)

SETFINDEX-DIRECT-SLOT-DEFINITION-CLASS (NEW-VALUE OBJECT)

INDEX-EFFECTIVE-SLOT-DEFINITION-INDICES (OBJECT)

SETFINDEX-EFFECTIVE-SLOT-DEFINITION-INDICES (NEW-VALUE OBJECT)

INDEXED-CLASS-INDEX-DEFINITIONS (OBJECT)

SETFINDEXED-CLASS-INDEX-DEFINITIONS (NEW-VALUE OBJECT)

INDEXED-CLASS-INDICES (OBJECT)

SETFINDEXED-CLASS-INDICES (NEW-VALUE OBJECT)

INDEXED-CLASS-OLD-INDICES (OBJECT)

SETFINDEXED-CLASS-OLD-INDICES (NEW-VALUE OBJECT)

SKIP-LIST-INDEX-INDEX-NIL (OBJECT)

SETFSKIP-LIST-INDEX-INDEX-NIL (NEW-VALUE OBJECT)

SKIP-LIST-INDEX-SKIP-LIST (OBJECT)

SETFSKIP-LIST-INDEX-SKIP-LIST (NEW-VALUE OBJECT)

SKIP-LIST-INDEX-SLOT-NAME (OBJECT)

SETFSKIP-LIST-INDEX-SLOT-NAME (NEW-VALUE OBJECT)

VARIABLE

Public

Undocumented

*INDEXED-CLASS-OVERRIDE*

Private

Undocumented

*IN-MAKE-INSTANCE-P*

*INDICES-REMOVE-P*

CLASS

Public

Undocumented

ARRAY-INDEX

CATEGORY-INDEX

CLASS-INDEX

CLASS-SKIP-INDEX

HASH-INDEX

HASH-LIST-INDEX

INDEX-DIRECT-SLOT-DEFINITION

INDEX-EFFECTIVE-SLOT-DEFINITION

INDEXED-CLASS

SKIP-LIST-INDEX

SLOT-INDEX

STRING-UNIQUE-INDEX

UNIQUE-INDEX

Private

Undocumented

CATEGORY-TREE

INDEX-HOLDER

CONDITION

Public

Undocumented

INDEX-EXISTING-ERROR