The xml-mop Reference Manual

Table of Contents

The xml-mop Reference Manual

This is the xml-mop Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:38:30 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 xml-mop

Author

Red Daly <reddaly at gmail>

License

MIT License

Description

xml-mop allows representing parts of XML documents as CLOS objects

Version

0.0.1

Dependencies

• s-xml
• closer-mop

Source

xml-mop.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 xml-mop/src

Parent

xml-mop (system)

Location

src/

Components

• package.lisp (file)
• xml-model.lisp (file)
• parsing.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 xml-mop.asd

Location

xml-mop.asd

Systems

xml-mop (system)

Packages

org.iodb.xml-mop-system

3.1.2 xml-mop/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

org.iodb.xml-mop

3.1.3 xml-mop/src/xml-model.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/xml-model.lisp

Exported Definitions

• element (class)
• element-class (class)
• element-text (method)
• (setf element-text) (method)

Internal Definitions

• assign-node-tag-descriptors (function)
• descriptor-case-sensitive (method)
• descriptor-element-type (method)
• descriptor-element-type (method)
• descriptor-matcher (method)
• descriptor-multiple (method)
• descriptor-multiple (method)
• descriptor-primary-description (method)
• descriptor-tag-aliases (method)
• element-class-auto (method)
• (setf element-class-auto) (method)
• element-class-parser (method)
• element-class-reduces-to (method)
• (setf element-class-reduces-to) (method)
• element-class-tag-descriptors (method)
• (setf element-class-tag-descriptors) (method)
• element-direct-slot-definition (class)
• element-effective-slot-definition (class)
• element-slot-attribute (method)
• (setf element-slot-attribute) (method)
• element-slot-attributes (generic function)
• element-slot-attributes (method)
• (setf element-slot-attributes) (method)
• element-slot-subelement (method)
• (setf element-slot-subelement) (method)
• element-slot-subelements (generic function)
• element-slot-subelements (method)
• (setf element-slot-subelements) (method)
• element-tag-string (method)
• (setf element-tag-string) (method)
• ensure-list (function)
• named-node-descriptor (class)
• node-class-allowed-elements (method)
• (setf node-class-allowed-elements) (method)
• parse-node-tag-descriptors (function)
• parse-subelement-descriptor-aliases (function)
• parser-case-insensitive-table (method)
• parser-case-sensitive-table (method)
• parser-lambda-table (method)
• resolve-node-descriptor-definition (function)
• resolve-subelement-descriptor-definition (function)
• standard-parser (class)
• subelement-descriptor (class)
• xml-treenode-class (class)

3.1.4 xml-mop/src/parsing.lisp

Dependency

xml-model.lisp (file)

Parent

src (module)

Location

src/parsing.lisp

Exported Definitions

• child-element-value (generic function)
• child-element-value (method)
• element-value (generic function)
• element-value (method)
• encountered-unknown-element (condition)
• on-loaded-from-xml (generic function)
• on-loaded-from-xml (method)
• on-start-xml-load (generic function)
• on-start-xml-load (method)
• parse-xml-stream (function)

Internal Definitions

• active-handle-finish-element (function)
• active-handle-new-element (function)
• active-handle-text (function)
• active-parse-stream (function)
• assign-attribute (generic function)
• assign-attribute (method)
• assign-attributes (generic function)
• assign-attributes (method)
• assign-child-element (function)
• condition-element-name (method)
• (setf condition-element-name) (method)
• condition-parent-element (method)
• (setf condition-parent-element) (method)
• descriptor-matches-name? (generic function)
• descriptor-matches-name? (method)
• descriptor-matches? (function)
• destructure-seed (function)
• determine-element-class-matching-tag (function)
• encountered-unmatched-attribute (condition)
• finalize-after-parse (generic function)
• finalize-after-parse (method)
• find-allowed-element (generic function)
• find-allowed-element (method)
• find-allowed-element (method)
• find-slot-matching-attribute (generic function)
• find-slot-matching-attribute (method)
• find-slot-matching-subelement (generic function)
• find-slot-matching-subelement (method)
• find-slot-matching-subelement (method)
• find-subelement-matching-tag (generic function)
• find-subelement-matching-tag (method)
• generate-seed (function)
• process-element (generic function)

4 Packages

Packages are listed by definition order.

4.1 org.iodb.xml-mop-system

Source

xml-mop.asd

Use List

• asdf/interface
• common-lisp

4.2 org.iodb.xml-mop

xml-mop allows representing parts of XML documents as CLOS objects

Source

package.lisp (file)

Nickname

xml-mop

Use List

• s-xml
• common-lisp

Exported Definitions

• child-element-value (generic function)
• child-element-value (method)
• element (class)
• element-class (class)
• element-text (generic function)
• element-text (method)
• (setf element-text) (method)
• (setf element-text) (generic function)
• element-value (generic function)
• element-value (method)
• encountered-unknown-element (condition)
• on-loaded-from-xml (generic function)
• on-loaded-from-xml (method)
• on-start-xml-load (generic function)
• on-start-xml-load (method)
• parse-xml-stream (function)

Internal Definitions

• active-handle-finish-element (function)
• active-handle-new-element (function)
• active-handle-text (function)
• active-parse-stream (function)
• assign-attribute (generic function)
• assign-attribute (method)
• assign-attributes (generic function)
• assign-attributes (method)
• assign-child-element (function)
• assign-node-tag-descriptors (function)
• condition-element-name (generic function)
• condition-element-name (method)
• (setf condition-element-name) (method)
• (setf condition-element-name) (generic function)
• condition-parent-element (generic function)
• condition-parent-element (method)
• (setf condition-parent-element) (method)
• (setf condition-parent-element) (generic function)
• descriptor-case-sensitive (generic function)
• descriptor-case-sensitive (method)
• descriptor-element-type (generic function)
• descriptor-element-type (method)
• descriptor-element-type (method)
• descriptor-matcher (generic function)
• descriptor-matcher (method)
• descriptor-matches-name? (generic function)
• descriptor-matches-name? (method)
• descriptor-matches? (function)
• descriptor-multiple (generic function)
• descriptor-multiple (method)
• descriptor-multiple (method)
• descriptor-primary-description (generic function)
• descriptor-primary-description (method)
• descriptor-tag-aliases (generic function)
• descriptor-tag-aliases (method)
• destructure-seed (function)
• determine-element-class-matching-tag (function)
• element-class-auto (generic function)
• element-class-auto (method)
• (setf element-class-auto) (method)
• (setf element-class-auto) (generic function)
• element-class-parser (generic function)
• element-class-parser (method)
• element-class-reduces-to (generic function)
• element-class-reduces-to (method)
• (setf element-class-reduces-to) (method)
• (setf element-class-reduces-to) (generic function)
• element-class-tag-descriptors (generic function)
• element-class-tag-descriptors (method)
• (setf element-class-tag-descriptors) (method)
• (setf element-class-tag-descriptors) (generic function)
• element-direct-slot-definition (class)
• element-effective-slot-definition (class)
• element-slot-attribute (generic function)
• element-slot-attribute (method)
• (setf element-slot-attribute) (method)
• (setf element-slot-attribute) (generic function)
• element-slot-attributes (generic function)
• element-slot-attributes (method)
• (setf element-slot-attributes) (generic function)
• (setf element-slot-attributes) (method)
• element-slot-subelement (generic function)
• element-slot-subelement (method)
• (setf element-slot-subelement) (method)
• (setf element-slot-subelement) (generic function)
• element-slot-subelements (generic function)
• element-slot-subelements (method)
• (setf element-slot-subelements) (generic function)
• (setf element-slot-subelements) (method)
• element-tag-string (generic function)
• element-tag-string (method)
• (setf element-tag-string) (method)
• (setf element-tag-string) (generic function)
• encountered-unmatched-attribute (condition)
• ensure-list (function)
• finalize-after-parse (generic function)
• finalize-after-parse (method)
• find-allowed-element (generic function)
• find-allowed-element (method)
• find-allowed-element (method)
• find-slot-matching-attribute (generic function)
• find-slot-matching-attribute (method)
• find-slot-matching-subelement (generic function)
• find-slot-matching-subelement (method)
• find-slot-matching-subelement (method)
• find-subelement-matching-tag (generic function)
• find-subelement-matching-tag (method)
• generate-seed (function)
• named-node-descriptor (class)
• node-class-allowed-elements (generic function)
• node-class-allowed-elements (method)
• (setf node-class-allowed-elements) (method)
• (setf node-class-allowed-elements) (generic function)
• parse-node-tag-descriptors (function)
• parse-subelement-descriptor-aliases (function)
• parser-case-insensitive-table (generic function)
• parser-case-insensitive-table (method)
• parser-case-sensitive-table (generic function)
• parser-case-sensitive-table (method)
• parser-lambda-table (generic function)
• parser-lambda-table (method)
• process-element (generic function)
• resolve-node-descriptor-definition (function)
• resolve-subelement-descriptor-definition (function)
• standard-parser (class)
• subelement-descriptor (class)
• xml-treenode-class (class)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: parse-xml-stream STREAM ACCEPTABLE-ROOT-CLASSES

This is where we interact with s-xml. Returns a list of the parsed root elements. Usually there is only one unless you are doing something weird.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

5.1.2 Generic functions

Generic Function: child-element-value CHILD-ELEMENT PARENT-ELEMENT PARENT-SLOT

Returns the value that child-element takes when assigned to parent-slot on parent-element

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: child-element-value CHILD-ELEMENT PARENT-ELEMENT PARENT-SLOT

By default do not do anything special, just return the element-value of the child element

Generic Function: element-text OBJECT

Generic Function: (setf element-text) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-text (ELEMENT element)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-text) NEW-VALUE (ELEMENT element)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-value ELEMENT

Returns the ’value’ of the element in general. This depends on
the element. For example, if it is a price, then this might return a number in US cents. This function is called on the element by default before it is assigned as the slot-value to a parent element.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: element-value ELEMENT

In general, the value of an element is itself.

Generic Function: on-loaded-from-xml ELEMENT

Called when the element has finished loading in the xml stream.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: on-loaded-from-xml (ELEMENT element)

Generic Function: on-start-xml-load ELEMENT

Called when the element has started to load in the xml stream. After attribs have been assigned.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: on-start-xml-load (ELEMENT element)

5.1.3 Conditions

Condition: encountered-unknown-element ()

Raised when an element is encountered with no matching xml-mop class.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Direct superclasses

error (condition)

Direct methods

• condition-parent-element (method)
• condition-parent-element (method)
• condition-element-name (method)
• condition-element-name (method)

Direct slots

Slot: element-name

Initargs

:element-name

Initform

(quote nil)

Readers

condition-element-name (generic function)

Writers

(setf condition-element-name) (generic function)

Slot: parent-element

Initargs

:parent-element

Initform

(quote nil)

Readers

condition-parent-element (generic function)

Writers

(setf condition-parent-element) (generic function)

5.1.4 Classes

Class: element ()

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• finalize-after-parse (method)
• assign-attributes (method)
• assign-attribute (method)
• find-slot-matching-attribute (method)
• find-allowed-element (method)
• on-loaded-from-xml (method)
• on-start-xml-load (method)
• element-tag-string (method)
• element-tag-string (method)
• element-text (method)
• element-text (method)

Direct slots

Slot: text

Initargs

:text

Readers

element-text (generic function)

Writers

(setf element-text) (generic function)

Slot: tag-string

Initargs

:tag

Readers

element-tag-string (generic function)

Writers

(setf element-tag-string) (generic function)

Class: element-class ()

A metaclass for XML elements. An additional option that
can be passed to element classes is the :tags option, which accepts a sequence of node-string identifiers.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

xml-treenode-class (class)

Direct methods

• find-subelement-matching-tag (method)
• find-slot-matching-subelement (method)
• reinitialize-instance (method)
• initialize-instance (method)
• reinitialize-instance (method)
• initialize-instance (method)
• validate-superclass (method)
• compute-effective-slot-definition (method)
• effective-slot-definition-class (method)
• direct-slot-definition-class (method)
• element-class-reduces-to (method)
• element-class-reduces-to (method)
• element-class-auto (method)
• element-class-auto (method)
• element-class-tag-descriptors (method)
• element-class-tag-descriptors (method)

Direct slots

Slot: tags

Initargs

:tags

Readers

element-class-tag-descriptors (generic function)

Writers

(setf element-class-tag-descriptors) (generic function)

Slot: auto

Initargs

:auto

Initform

t

Readers

element-class-auto (generic function)

Writers

(setf element-class-auto) (generic function)

Slot: reduces-to

Initargs

:reduces-to

Readers

element-class-reduces-to (generic function)

Writers

(setf element-class-reduces-to) (generic function)

5.2 Internal definitions

5.2.1 Functions

Function: active-handle-finish-element NAME ATTRIBUTES PARENT-SEED SEED

Called when the end of an element is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: active-handle-new-element NAME ATTRIBUTES SEED

Called when an element is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: active-handle-text STRING SEED

Called when text is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: active-parse-stream STREAM DOC-CLASS

This is where we interact with s-xml.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: assign-child-element PARENT-ELEMENT NEW-CHILD-ELEMENT PARENT-SLOT

Assigns a child element to the given slot of the parent element. This function
takes into account the user’s preferences for child element plurality and type conversion of the element.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: assign-node-tag-descriptors NODE-CLASS PARSED-TAG-DESCRIPTORS

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Function: descriptor-matches? DESCRIPTOR TEST-STRING

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: destructure-seed SEED

Returns multiple values:

1. element stack
2. allowed-root-element-classes 3. root elements
4. slot

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: determine-element-class-matching-tag ALLOWED-ELEMENT-CLASS TAG-NAME

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: ensure-list MY-LIST

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Function: generate-seed ELEMENT-STACK ALLOWED-ROOT-ELEMENT-CLASSES ROOT-ELEMENTS PARENT-SLOTS

Generates the seed that is passed along as an XML stream is parsed. This is currently not the greatest system because of how the parse system is set up (event-driven, and does not allow extra consumption).
Currently a seed encodes the following data:
the element classes allowed as root elements
* a list of root elements encountered so far
* the corresponding slots on the element stack
* the element stack as a list
* a list of slots that correspond to elements on the stack, which will be assigned when elements on the stack are popped off

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Function: parse-node-tag-descriptors TAG-DESCRIPTORS

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Function: parse-subelement-descriptor-aliases &key ELEMENT-TYPE ALIAS MULTIPLE

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Function: resolve-node-descriptor-definition DESCRIPTOR-DEFINITION

Takes either a list of descriptor-definitions or a single descriptor definition.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Function: resolve-subelement-descriptor-definition DESCRIPTOR-DEFINITION

Does not allow multiple descriptor definitions as is the case for a node descriptor.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

5.2.2 Generic functions

Generic Function: assign-attribute ELEMENT NAME ATTR-VALUE

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: assign-attribute (ELEMENT element) NAME ATTR-VALUE

Generic Function: assign-attributes ELEMENT ATTRIBUTES

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: assign-attributes (ELEMENT element) ATTRIBUTES

Generic Function: condition-element-name CONDITION

Generic Function: (setf condition-element-name) NEW-VALUE CONDITION

Package

org.iodb.xml-mop

Methods

Method: condition-element-name (CONDITION encountered-unknown-element)

Method: (setf condition-element-name) NEW-VALUE (CONDITION encountered-unknown-element)

Source

parsing.lisp (file)

Generic Function: condition-parent-element CONDITION

Generic Function: (setf condition-parent-element) NEW-VALUE CONDITION

Package

org.iodb.xml-mop

Methods

Method: condition-parent-element (CONDITION encountered-unknown-element)

Method: (setf condition-parent-element) NEW-VALUE (CONDITION encountered-unknown-element)

Source

parsing.lisp (file)

Generic Function: descriptor-case-sensitive OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-case-sensitive (NAMED-NODE-DESCRIPTOR named-node-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Generic Function: descriptor-element-type OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-element-type (SUBELEMENT-DESCRIPTOR subelement-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Method: descriptor-element-type (NAMED-NODE-DESCRIPTOR named-node-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Generic Function: descriptor-matcher OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-matcher (NAMED-NODE-DESCRIPTOR named-node-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Generic Function: descriptor-matches-name? DESCRIPTOR TEST-STRING

Determines if the given descriptor matches the test string. Remember, a descriptor is a way to specify nodes in an XML document. The test string is a node name, probably a tag or attribute.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: descriptor-matches-name? (DESCRIPTOR named-node-descriptor) TEST-STRING

Generic Function: descriptor-multiple OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-multiple (SUBELEMENT-DESCRIPTOR subelement-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Method: descriptor-multiple (NAMED-NODE-DESCRIPTOR named-node-descriptor)

automatically generated reader method

Source

xml-model.lisp (file)

Generic Function: descriptor-primary-description OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-primary-description (NAMED-NODE-DESCRIPTOR named-node-descriptor)

If this is true, then this is the description used to
output an XML version of this descriptor.

Source

xml-model.lisp (file)

Generic Function: descriptor-tag-aliases OBJECT

Package

org.iodb.xml-mop

Methods

Method: descriptor-tag-aliases (SUBELEMENT-DESCRIPTOR subelement-descriptor)

alternative node descriptors for this subelement.

Source

xml-model.lisp (file)

Generic Function: element-class-auto OBJECT

Generic Function: (setf element-class-auto) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-class-auto (ELEMENT-CLASS element-class)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-class-auto) NEW-VALUE (ELEMENT-CLASS element-class)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-class-parser OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-class-parser (XML-TREENODE-CLASS xml-treenode-class)

automatically generated reader method

Source

xml-model.lisp (file)

Generic Function: element-class-reduces-to OBJECT

Generic Function: (setf element-class-reduces-to) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-class-reduces-to (ELEMENT-CLASS element-class)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-class-reduces-to) NEW-VALUE (ELEMENT-CLASS element-class)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-class-tag-descriptors OBJECT

Generic Function: (setf element-class-tag-descriptors) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-class-tag-descriptors (ELEMENT-CLASS element-class)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-class-tag-descriptors) NEW-VALUE (ELEMENT-CLASS element-class)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-slot-attribute OBJECT

Generic Function: (setf element-slot-attribute) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-slot-attribute (ELEMENT-DIRECT-SLOT-DEFINITION element-direct-slot-definition)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-slot-attribute) NEW-VALUE (ELEMENT-DIRECT-SLOT-DEFINITION element-direct-slot-definition)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-slot-attributes SLOT-DEFINITION

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Writer

(setf element-slot-attributes) (generic function)

Methods

Method: element-slot-attributes (ELEMENT-EFFECTIVE-SLOT-DEFINITION element-effective-slot-definition)

automatically generated reader method

Generic Function: (setf element-slot-attributes) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Reader

element-slot-attributes (generic function)

Methods

Method: (setf element-slot-attributes) NEW-VALUE (ELEMENT-EFFECTIVE-SLOT-DEFINITION element-effective-slot-definition)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-slot-subelement OBJECT

Generic Function: (setf element-slot-subelement) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-slot-subelement (ELEMENT-DIRECT-SLOT-DEFINITION element-direct-slot-definition)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-slot-subelement) NEW-VALUE (ELEMENT-DIRECT-SLOT-DEFINITION element-direct-slot-definition)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-slot-subelements SLOT-DEFINITION

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Writer

(setf element-slot-subelements) (generic function)

Methods

Method: element-slot-subelements (ELEMENT-EFFECTIVE-SLOT-DEFINITION element-effective-slot-definition)

automatically generated reader method

Generic Function: (setf element-slot-subelements) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Reader

element-slot-subelements (generic function)

Methods

Method: (setf element-slot-subelements) NEW-VALUE (ELEMENT-EFFECTIVE-SLOT-DEFINITION element-effective-slot-definition)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: element-tag-string OBJECT

Generic Function: (setf element-tag-string) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: element-tag-string (ELEMENT element)

automatically generated reader method

Source

xml-model.lisp (file)

Method: (setf element-tag-string) NEW-VALUE (ELEMENT element)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: finalize-after-parse ELEMENT

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: finalize-after-parse (ELEMENT element)

Generic Function: find-allowed-element PARENT-ELEMENT TAG-NAME

Finds the element class underneath parent-element that corresponds to the tag string.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: find-allowed-element (PARENT-ELEMENT-CLASS xml-treenode-class) TAG-NAME

Method: find-allowed-element (PARENT-ELEMENT element) TAG-NAME

Generic Function: find-slot-matching-attribute ELEMENT ATTR-NAME

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: find-slot-matching-attribute (ELEMENT element) ATTR-NAME

Generic Function: find-slot-matching-subelement ELEMENT TAG-NAME

Finds a slot in an element class that matches the tag-name given

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: find-slot-matching-subelement (PARENT-ELEMENT-CLASS element-class) TAG-NAME

Method: find-slot-matching-subelement NON-PARENT-ELEMENT-CLASS TAG-NAME

Generic Function: find-subelement-matching-tag PARENT-ELEMENT TAG-NAME

Finds the most specific sub-element class of the supplied parent
element (generally an element class) that matches the tag string. This will check the slot definitions of the class for a slot with matching ’subelement’ descriptor, and then check the allowed-subelements field of the class.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Methods

Method: find-subelement-matching-tag (PARENT-ELEMENT-CLASS element-class) TAG-NAME

Generic Function: node-class-allowed-elements OBJECT

Generic Function: (setf node-class-allowed-elements) NEW-VALUE OBJECT

Package

org.iodb.xml-mop

Methods

Method: node-class-allowed-elements (NODE-CLASS xml-treenode-class)

Source

xml-model.lisp (file)

Method: (setf node-class-allowed-elements) NEW-VALUE (XML-TREENODE-CLASS xml-treenode-class)

automatically generated writer method

Source

xml-model.lisp (file)

Generic Function: parser-case-insensitive-table OBJECT

Package

org.iodb.xml-mop

Methods

Method: parser-case-insensitive-table (STANDARD-PARSER standard-parser)

For looking up member elements by tag name.

Source

xml-model.lisp (file)

Generic Function: parser-case-sensitive-table OBJECT

Package

org.iodb.xml-mop

Methods

Method: parser-case-sensitive-table (STANDARD-PARSER standard-parser)

For looking up member elements by tag name.

Source

xml-model.lisp (file)

Generic Function: parser-lambda-table OBJECT

Package

org.iodb.xml-mop

Methods

Method: parser-lambda-table (STANDARD-PARSER standard-parser)

For looking up elements by calling a test function.

Source

xml-model.lisp (file)

Generic Function: process-element PARENT-ELEMENT TAG-NAME ATTRIBUTES

Adds the child element with the given tag name and attribs to the parent elem.

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

5.2.3 Conditions

Condition: encountered-unmatched-attribute ()

Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Direct superclasses

condition (condition)

5.2.4 Classes

Class: element-direct-slot-definition ()

Direct slots of ELEMENT-CLASS (that is those that are defined in
a defclass form where element-class is the metaclass) have an ATTRIBUTE and SUBELEMENT property. These direct slot definitions are transformed into effective slot definitions in compute-effective-slot-definition.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-direct-slot-definition (class)

Direct methods

• element-slot-attribute (method)
• element-slot-attribute (method)
• element-slot-subelement (method)
• element-slot-subelement (method)

Direct slots

Slot: subelement

Initargs

:subelement

Readers

element-slot-subelement (generic function)

Writers

(setf element-slot-subelement) (generic function)

Slot: attribute

Initargs

:attribute

Readers

element-slot-attribute (generic function)

Writers

(setf element-slot-attribute) (generic function)

Class: element-effective-slot-definition ()

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-effective-slot-definition (class)

Direct methods

• (setf element-slot-attributes) (method)
• element-slot-attributes (method)
• (setf element-slot-subelements) (method)
• element-slot-subelements (method)

Direct slots

Slot: subelements

Initargs

:subelements

Readers

element-slot-subelements (generic function)

Writers

(setf element-slot-subelements) (generic function)

Slot: attributes

Initargs

:attributes

Readers

element-slot-attributes (generic function)

Writers

(setf element-slot-attributes) (generic function)

Class: named-node-descriptor ()

This is the standard way to describe an XML node. A node descriptor helps map
from a cased or uncased string to a handler class or function. Several descriptors may map to a single element.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• descriptor-matches-name? (method)
• descriptor-primary-description (method)
• descriptor-multiple (method)
• descriptor-element-type (method)
• descriptor-case-sensitive (method)
• descriptor-matcher (method)

Direct slots

Slot: matcher

Initargs

:matcher, :string

Readers

descriptor-matcher (generic function)

Slot: case-sensitive

Initargs

:case-sensitive

Readers

descriptor-case-sensitive (generic function)

Slot: element-type

Initargs

:element-type

Readers

descriptor-element-type (generic function)

Slot: multiple

Initargs

:multiple

Readers

descriptor-multiple (generic function)

Slot: primary-description

If this is true, then this is the description used to
output an XML version of this descriptor.

Initargs

:primary

Readers

descriptor-primary-description (generic function)

Class: standard-parser ()

The parser class keeps track of element or attributes
an XML node can have. Typically, each element class has a parser associated with it that will attempt to look up a node. If that fails, a parser is invoked for the document.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• parser-lambda-table (method)
• parser-case-insensitive-table (method)
• parser-case-sensitive-table (method)

Direct slots

Slot: case-sensitive-table

For looking up member elements by tag name.

Initargs

:case-sensitive-table

Initform

(make-hash-table :test (function equal))

Readers

parser-case-sensitive-table (generic function)

Slot: case-insensitive-table

For looking up member elements by tag name.

Initargs

:cased-sensitive-table

Initform

(make-hash-table :test (function equalp))

Readers

parser-case-insensitive-table (generic function)

Slot: lambda-table

For looking up elements by calling a test function.

Initargs

:lambda-table

Readers

parser-lambda-table (generic function)

Class: subelement-descriptor ()

Describes a subelement associated with a slot on an element class.

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• descriptor-tag-aliases (method)
• descriptor-multiple (method)
• descriptor-element-type (method)

Direct slots

Slot: element-type

Initargs

:element-type

Readers

descriptor-element-type (generic function)

Slot: multiple

Initargs

:multiple

Readers

descriptor-multiple (generic function)

Slot: aliases

alternative node descriptors for this subelement.

Initargs

:aliases

Readers

descriptor-tag-aliases (generic function)

Class: xml-treenode-class ()

Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-class (class)

Direct subclasses

element-class (class)

Direct methods

• find-allowed-element (method)
• node-class-allowed-elements (method)
• element-class-parser (method)
• node-class-allowed-elements (method)

Direct slots

Slot: allowed-elements

Initargs

:allowed-elements

Readers

node-class-allowed-elements (generic function)

Writers

(setf node-class-allowed-elements) (generic function)

Slot: parser

Initargs

:parser

Initform

(make-instance (quote org.iodb.xml-mop::standard-parser))

Readers

element-class-parser (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types