The xml-mop Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The xml-mop Reference Manual

This is the xml-mop Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:31:56 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

xml-mop.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

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


Previous: , Up: Modules   [Contents][Index]

2.1 xml-mop/src

Parent

xml-mop (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 xml-mop.asd

Location

xml-mop.asd

Systems

xml-mop (system)

Packages

org.iodb.xml-mop-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 xml-mop/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

org.iodb.xml-mop


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

package.lisp (file)

Parent

src (module)

Location

src/xml-model.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 xml-mop/src/parsing.lisp

Dependency

xml-model.lisp (file)

Parent

src (module)

Location

src/parsing.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 org.iodb.xml-mop-system

Source

xml-mop.asd

Use List

Previous: , Up: Packages   [Contents][Index]

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
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)

Next: , Previous: , Up: Exported definitions   [Contents][Index]

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
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)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: element ()
Package

org.iodb.xml-mop

Source

xml-model.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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
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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Conditions

Condition: encountered-unmatched-attribute ()
Package

org.iodb.xml-mop

Source

parsing.lisp (file)

Direct superclasses

condition (condition)


Previous: , Up: Internal definitions   [Contents][Index]

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
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
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
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
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
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
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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   X  
Index Entry  Section

F
File, Lisp, xml-mop.asd: The xml-mop<dot>asd file
File, Lisp, xml-mop/src/package.lisp: The xml-mop/src/package<dot>lisp file
File, Lisp, xml-mop/src/parsing.lisp: The xml-mop/src/parsing<dot>lisp file
File, Lisp, xml-mop/src/xml-model.lisp: The xml-mop/src/xml-model<dot>lisp file

L
Lisp File, xml-mop.asd: The xml-mop<dot>asd file
Lisp File, xml-mop/src/package.lisp: The xml-mop/src/package<dot>lisp file
Lisp File, xml-mop/src/parsing.lisp: The xml-mop/src/parsing<dot>lisp file
Lisp File, xml-mop/src/xml-model.lisp: The xml-mop/src/xml-model<dot>lisp file

M
Module, xml-mop/src: The xml-mop/src module

X
xml-mop.asd: The xml-mop<dot>asd file
xml-mop/src: The xml-mop/src module
xml-mop/src/package.lisp: The xml-mop/src/package<dot>lisp file
xml-mop/src/parsing.lisp: The xml-mop/src/parsing<dot>lisp file
xml-mop/src/xml-model.lisp: The xml-mop/src/xml-model<dot>lisp file

Jump to:   F   L   M   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   N   O   P   R  
Index Entry  Section

(
(setf condition-element-name): Internal generic functions
(setf condition-element-name): Internal generic functions
(setf condition-parent-element): Internal generic functions
(setf condition-parent-element): Internal generic functions
(setf element-class-auto): Internal generic functions
(setf element-class-auto): Internal generic functions
(setf element-class-reduces-to): Internal generic functions
(setf element-class-reduces-to): Internal generic functions
(setf element-class-tag-descriptors): Internal generic functions
(setf element-class-tag-descriptors): Internal generic functions
(setf element-slot-attribute): Internal generic functions
(setf element-slot-attribute): Internal generic functions
(setf element-slot-attributes): Internal generic functions
(setf element-slot-attributes): Internal generic functions
(setf element-slot-subelement): Internal generic functions
(setf element-slot-subelement): Internal generic functions
(setf element-slot-subelements): Internal generic functions
(setf element-slot-subelements): Internal generic functions
(setf element-tag-string): Internal generic functions
(setf element-tag-string): Internal generic functions
(setf element-text): Exported generic functions
(setf element-text): Exported generic functions
(setf node-class-allowed-elements): Internal generic functions
(setf node-class-allowed-elements): Internal generic functions

A
active-handle-finish-element: Internal functions
active-handle-new-element: Internal functions
active-handle-text: Internal functions
active-parse-stream: Internal functions
assign-attribute: Internal generic functions
assign-attribute: Internal generic functions
assign-attributes: Internal generic functions
assign-attributes: Internal generic functions
assign-child-element: Internal functions
assign-node-tag-descriptors: Internal functions

C
child-element-value: Exported generic functions
child-element-value: Exported generic functions
condition-element-name: Internal generic functions
condition-element-name: Internal generic functions
condition-parent-element: Internal generic functions
condition-parent-element: Internal generic functions

D
descriptor-case-sensitive: Internal generic functions
descriptor-case-sensitive: Internal generic functions
descriptor-element-type: Internal generic functions
descriptor-element-type: Internal generic functions
descriptor-element-type: Internal generic functions
descriptor-matcher: Internal generic functions
descriptor-matcher: Internal generic functions
descriptor-matches-name?: Internal generic functions
descriptor-matches-name?: Internal generic functions
descriptor-matches?: Internal functions
descriptor-multiple: Internal generic functions
descriptor-multiple: Internal generic functions
descriptor-multiple: Internal generic functions
descriptor-primary-description: Internal generic functions
descriptor-primary-description: Internal generic functions
descriptor-tag-aliases: Internal generic functions
descriptor-tag-aliases: Internal generic functions
destructure-seed: Internal functions
determine-element-class-matching-tag: Internal functions

E
element-class-auto: Internal generic functions
element-class-auto: Internal generic functions
element-class-parser: Internal generic functions
element-class-parser: Internal generic functions
element-class-reduces-to: Internal generic functions
element-class-reduces-to: Internal generic functions
element-class-tag-descriptors: Internal generic functions
element-class-tag-descriptors: Internal generic functions
element-slot-attribute: Internal generic functions
element-slot-attribute: Internal generic functions
element-slot-attributes: Internal generic functions
element-slot-attributes: Internal generic functions
element-slot-subelement: Internal generic functions
element-slot-subelement: Internal generic functions
element-slot-subelements: Internal generic functions
element-slot-subelements: Internal generic functions
element-tag-string: Internal generic functions
element-tag-string: Internal generic functions
element-text: Exported generic functions
element-text: Exported generic functions
element-value: Exported generic functions
element-value: Exported generic functions
ensure-list: Internal functions

F
finalize-after-parse: Internal generic functions
finalize-after-parse: Internal generic functions
find-allowed-element: Internal generic functions
find-allowed-element: Internal generic functions
find-allowed-element: Internal generic functions
find-slot-matching-attribute: Internal generic functions
find-slot-matching-attribute: Internal generic functions
find-slot-matching-subelement: Internal generic functions
find-slot-matching-subelement: Internal generic functions
find-slot-matching-subelement: Internal generic functions
find-subelement-matching-tag: Internal generic functions
find-subelement-matching-tag: Internal generic functions
Function, active-handle-finish-element: Internal functions
Function, active-handle-new-element: Internal functions
Function, active-handle-text: Internal functions
Function, active-parse-stream: Internal functions
Function, assign-child-element: Internal functions
Function, assign-node-tag-descriptors: Internal functions
Function, descriptor-matches?: Internal functions
Function, destructure-seed: Internal functions
Function, determine-element-class-matching-tag: Internal functions
Function, ensure-list: Internal functions
Function, generate-seed: Internal functions
Function, parse-node-tag-descriptors: Internal functions
Function, parse-subelement-descriptor-aliases: Internal functions
Function, parse-xml-stream: Exported functions
Function, resolve-node-descriptor-definition: Internal functions
Function, resolve-subelement-descriptor-definition: Internal functions

G
generate-seed: Internal functions
Generic Function, (setf condition-element-name): Internal generic functions
Generic Function, (setf condition-parent-element): Internal generic functions
Generic Function, (setf element-class-auto): Internal generic functions
Generic Function, (setf element-class-reduces-to): Internal generic functions
Generic Function, (setf element-class-tag-descriptors): Internal generic functions
Generic Function, (setf element-slot-attribute): Internal generic functions
Generic Function, (setf element-slot-attributes): Internal generic functions
Generic Function, (setf element-slot-subelement): Internal generic functions
Generic Function, (setf element-slot-subelements): Internal generic functions
Generic Function, (setf element-tag-string): Internal generic functions
Generic Function, (setf element-text): Exported generic functions
Generic Function, (setf node-class-allowed-elements): Internal generic functions
Generic Function, assign-attribute: Internal generic functions
Generic Function, assign-attributes: Internal generic functions
Generic Function, child-element-value: Exported generic functions
Generic Function, condition-element-name: Internal generic functions
Generic Function, condition-parent-element: Internal generic functions
Generic Function, descriptor-case-sensitive: Internal generic functions
Generic Function, descriptor-element-type: Internal generic functions
Generic Function, descriptor-matcher: Internal generic functions
Generic Function, descriptor-matches-name?: Internal generic functions
Generic Function, descriptor-multiple: Internal generic functions
Generic Function, descriptor-primary-description: Internal generic functions
Generic Function, descriptor-tag-aliases: Internal generic functions
Generic Function, element-class-auto: Internal generic functions
Generic Function, element-class-parser: Internal generic functions
Generic Function, element-class-reduces-to: Internal generic functions
Generic Function, element-class-tag-descriptors: Internal generic functions
Generic Function, element-slot-attribute: Internal generic functions
Generic Function, element-slot-attributes: Internal generic functions
Generic Function, element-slot-subelement: Internal generic functions
Generic Function, element-slot-subelements: Internal generic functions
Generic Function, element-tag-string: Internal generic functions
Generic Function, element-text: Exported generic functions
Generic Function, element-value: Exported generic functions
Generic Function, finalize-after-parse: Internal generic functions
Generic Function, find-allowed-element: Internal generic functions
Generic Function, find-slot-matching-attribute: Internal generic functions
Generic Function, find-slot-matching-subelement: Internal generic functions
Generic Function, find-subelement-matching-tag: Internal generic functions
Generic Function, node-class-allowed-elements: Internal generic functions
Generic Function, on-loaded-from-xml: Exported generic functions
Generic Function, on-start-xml-load: Exported generic functions
Generic Function, parser-case-insensitive-table: Internal generic functions
Generic Function, parser-case-sensitive-table: Internal generic functions
Generic Function, parser-lambda-table: Internal generic functions
Generic Function, process-element: Internal generic functions

M
Method, (setf condition-element-name): Internal generic functions
Method, (setf condition-parent-element): Internal generic functions
Method, (setf element-class-auto): Internal generic functions
Method, (setf element-class-reduces-to): Internal generic functions
Method, (setf element-class-tag-descriptors): Internal generic functions
Method, (setf element-slot-attribute): Internal generic functions
Method, (setf element-slot-attributes): Internal generic functions
Method, (setf element-slot-subelement): Internal generic functions
Method, (setf element-slot-subelements): Internal generic functions
Method, (setf element-tag-string): Internal generic functions
Method, (setf element-text): Exported generic functions
Method, (setf node-class-allowed-elements): Internal generic functions
Method, assign-attribute: Internal generic functions
Method, assign-attributes: Internal generic functions
Method, child-element-value: Exported generic functions
Method, condition-element-name: Internal generic functions
Method, condition-parent-element: Internal generic functions
Method, descriptor-case-sensitive: Internal generic functions
Method, descriptor-element-type: Internal generic functions
Method, descriptor-element-type: Internal generic functions
Method, descriptor-matcher: Internal generic functions
Method, descriptor-matches-name?: Internal generic functions
Method, descriptor-multiple: Internal generic functions
Method, descriptor-multiple: Internal generic functions
Method, descriptor-primary-description: Internal generic functions
Method, descriptor-tag-aliases: Internal generic functions
Method, element-class-auto: Internal generic functions
Method, element-class-parser: Internal generic functions
Method, element-class-reduces-to: Internal generic functions
Method, element-class-tag-descriptors: Internal generic functions
Method, element-slot-attribute: Internal generic functions
Method, element-slot-attributes: Internal generic functions
Method, element-slot-subelement: Internal generic functions
Method, element-slot-subelements: Internal generic functions
Method, element-tag-string: Internal generic functions
Method, element-text: Exported generic functions
Method, element-value: Exported generic functions
Method, finalize-after-parse: Internal generic functions
Method, find-allowed-element: Internal generic functions
Method, find-allowed-element: Internal generic functions
Method, find-slot-matching-attribute: Internal generic functions
Method, find-slot-matching-subelement: Internal generic functions
Method, find-slot-matching-subelement: Internal generic functions
Method, find-subelement-matching-tag: Internal generic functions
Method, node-class-allowed-elements: Internal generic functions
Method, on-loaded-from-xml: Exported generic functions
Method, on-start-xml-load: Exported generic functions
Method, parser-case-insensitive-table: Internal generic functions
Method, parser-case-sensitive-table: Internal generic functions
Method, parser-lambda-table: Internal generic functions

N
node-class-allowed-elements: Internal generic functions
node-class-allowed-elements: Internal generic functions

O
on-loaded-from-xml: Exported generic functions
on-loaded-from-xml: Exported generic functions
on-start-xml-load: Exported generic functions
on-start-xml-load: Exported generic functions

P
parse-node-tag-descriptors: Internal functions
parse-subelement-descriptor-aliases: Internal functions
parse-xml-stream: Exported functions
parser-case-insensitive-table: Internal generic functions
parser-case-insensitive-table: Internal generic functions
parser-case-sensitive-table: Internal generic functions
parser-case-sensitive-table: Internal generic functions
parser-lambda-table: Internal generic functions
parser-lambda-table: Internal generic functions
process-element: Internal generic functions

R
resolve-node-descriptor-definition: Internal functions
resolve-subelement-descriptor-definition: Internal functions

Jump to:   (  
A   C   D   E   F   G   M   N   O   P   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   A   C   E   L   M   P   R   S   T  
Index Entry  Section

A
aliases: Internal classes
allowed-elements: Internal classes
attribute: Internal classes
attributes: Internal classes
auto: Exported classes

C
case-insensitive-table: Internal classes
case-sensitive: Internal classes
case-sensitive-table: Internal classes

E
element-name: Exported conditions
element-type: Internal classes
element-type: Internal classes

L
lambda-table: Internal classes

M
matcher: Internal classes
multiple: Internal classes
multiple: Internal classes

P
parent-element: Exported conditions
parser: Internal classes
primary-description: Internal classes

R
reduces-to: Exported classes

S
Slot, aliases: Internal classes
Slot, allowed-elements: Internal classes
Slot, attribute: Internal classes
Slot, attributes: Internal classes
Slot, auto: Exported classes
Slot, case-insensitive-table: Internal classes
Slot, case-sensitive: Internal classes
Slot, case-sensitive-table: Internal classes
Slot, element-name: Exported conditions
Slot, element-type: Internal classes
Slot, element-type: Internal classes
Slot, lambda-table: Internal classes
Slot, matcher: Internal classes
Slot, multiple: Internal classes
Slot, multiple: Internal classes
Slot, parent-element: Exported conditions
Slot, parser: Internal classes
Slot, primary-description: Internal classes
Slot, reduces-to: Exported classes
Slot, subelement: Internal classes
Slot, subelements: Internal classes
Slot, tag-string: Exported classes
Slot, tags: Exported classes
Slot, text: Exported classes
subelement: Internal classes
subelements: Internal classes

T
tag-string: Exported classes
tags: Exported classes
text: Exported classes

Jump to:   A   C   E   L   M   P   R   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   E   N   O   P   S   X  
Index Entry  Section

C
Class, element: Exported classes
Class, element-class: Exported classes
Class, element-direct-slot-definition: Internal classes
Class, element-effective-slot-definition: Internal classes
Class, named-node-descriptor: Internal classes
Class, standard-parser: Internal classes
Class, subelement-descriptor: Internal classes
Class, xml-treenode-class: Internal classes
Condition, encountered-unknown-element: Exported conditions
Condition, encountered-unmatched-attribute: Internal conditions

E
element: Exported classes
element-class: Exported classes
element-direct-slot-definition: Internal classes
element-effective-slot-definition: Internal classes
encountered-unknown-element: Exported conditions
encountered-unmatched-attribute: Internal conditions

N
named-node-descriptor: Internal classes

O
org.iodb.xml-mop: The org<dot>iodb<dot>xml-mop package
org.iodb.xml-mop-system: The org<dot>iodb<dot>xml-mop-system package

P
Package, org.iodb.xml-mop: The org<dot>iodb<dot>xml-mop package
Package, org.iodb.xml-mop-system: The org<dot>iodb<dot>xml-mop-system package

S
standard-parser: Internal classes
subelement-descriptor: Internal classes
System, xml-mop: The xml-mop system

X
xml-mop: The xml-mop system
xml-treenode-class: Internal classes

Jump to:   C   E   N   O   P   S   X