1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
#
# Berkeley DB XML is an embedded native XML datastore that provides for
# the efficient storage and retrieval of XML encoded information.
#
# Retrieval is supported by an XPath query engine that derives its efficiency
# from indices generated from the stored XML data.
#
# The following classes are defined
#
# * BDB::XML::Container
#
# The container name provides the base for the filenames of the database
# files used to store the container content. The directory within which
# the files are opened is taken from the environment passed through the
# Container constructor. If no environment was provided, then the
# directory used will be the current working directory.
#
# * BDB::XML::Index
#
# Define the indexing strategy for a Container
#
# Indexing is specified by providing the name of a node and a list of
# indexing strategies for that node.
#
# * BDB::XML::Document
#
# A Document is the unit of storage within a Container.
#
# A Document contains a stream of bytes that may be of type XML.
# The Container only indexes the content of Documents
# that contain XML.
#
# Document supports annotation attributes.
#
#
# * BDB::XML::Context
#
# The context within which a query is performed against a Container.
#
# The context within which a query is performed against a Container
# is complex enough to warrent an encapsulating class. This context
# includes a namespace mapping, variable bindings, and flags that
# determine how the query result set should be determined and returned
# to the caller.
#
# The XPath syntax permits expressions to refer to namespace prefixes, but
# not to define them. The Context class provides a number of namespace
# management methods so that the caller may manage the namespace prefix
# to URI mapping.
#
# The XPath syntax also permits expressions to refer to variables, but not
# to define them. The Context class provides a number of methods so
# that the caller may manage the variable to value bindings.
#
# * BDB::XML::Modify
#
# Modify encapsulates the context within which a set of documents specified by
# a query can be modified in place.
#
# The modification is performed using the methods
# <em>BDB::XML::Container#modify</em> and <em>BDB::XML::Document#modify</em>
#
# There are two parts to the object -- the query and the operation.
# The query identifies target nodes against which the operation is run.
# The operation specifies what modifications to perform.
#
# * BDB::XML::Results
#
#
# The results of a query are a collection of values. The values could
# be either String, Float, true, false, BDB::XML::Documents or BDB::XML::Nodes
#
#
module BDB::XML
end
|