diff options
| author | gromgull <gromgull@gmail.com> | 2013-05-07 16:39:46 +0200 |
|---|---|---|
| committer | gromgull <gromgull@gmail.com> | 2013-05-07 16:39:46 +0200 |
| commit | 9e18ba31917fdc17fbc4f11a12d98141afbac1f6 (patch) | |
| tree | a57afa8c75a70e4791bb9e7469442a3839901e1e /docs/modules | |
| parent | 071ece8d2c3a507b3000f4495c5d314bdd77687b (diff) | |
| download | rdflib-9e18ba31917fdc17fbc4f11a12d98141afbac1f6.tar.gz | |
doc updates
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/collection.rst | 11 | ||||
| -rw-r--r-- | docs/modules/events.rst | 12 | ||||
| -rw-r--r-- | docs/modules/graphs/conjunctive_graph.rst | 30 | ||||
| -rw-r--r-- | docs/modules/graphs/dataset.rst | 7 | ||||
| -rw-r--r-- | docs/modules/graphs/graph.rst | 7 | ||||
| -rw-r--r-- | docs/modules/graphs/index.rst | 63 | ||||
| -rw-r--r-- | docs/modules/graphs/quoted_graph.rst | 11 | ||||
| -rw-r--r-- | docs/modules/index.rst | 22 | ||||
| -rw-r--r-- | docs/modules/namespace.rst | 16 | ||||
| -rw-r--r-- | docs/modules/node.rst | 40 | ||||
| -rw-r--r-- | docs/modules/parser.rst | 26 | ||||
| -rw-r--r-- | docs/modules/resource.rst | 7 | ||||
| -rw-r--r-- | docs/modules/result.rst | 10 | ||||
| -rw-r--r-- | docs/modules/serializer.rst | 12 | ||||
| -rw-r--r-- | docs/modules/statement.rst | 13 | ||||
| -rw-r--r-- | docs/modules/store.rst | 23 | ||||
| -rw-r--r-- | docs/modules/term.rst | 24 | ||||
| -rw-r--r-- | docs/modules/util.rst | 38 |
18 files changed, 0 insertions, 372 deletions
diff --git a/docs/modules/collection.rst b/docs/modules/collection.rst deleted file mode 100644 index 94f63e9e..00000000 --- a/docs/modules/collection.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _others: Other modules - - -============= -Collection -============= - -.. automodule:: rdflib.collection -.. :noindex: -.. autoclass:: rdflib.collection.Collection - :members: diff --git a/docs/modules/events.rst b/docs/modules/events.rst deleted file mode 100644 index 5e6abed6..00000000 --- a/docs/modules/events.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _rdflib.events: Event registration - -====== -Events -====== -.. automodule:: rdflib.events -.. :noindex: -.. autoclass:: rdflib.events.Event - :members: -.. autoclass:: rdflib.events.Dispatcher - :members: - diff --git a/docs/modules/graphs/conjunctive_graph.rst b/docs/modules/graphs/conjunctive_graph.rst deleted file mode 100644 index 2c6fce87..00000000 --- a/docs/modules/graphs/conjunctive_graph.rst +++ /dev/null @@ -1,30 +0,0 @@ -:mod:`rdflib.Graph.ConjunctiveGraph` -- ConjunctiveGraph -======================================================== - -.. autoclass:: rdflib.graph.ConjunctiveGraph - :members: - -Modelling notes ----------------- -This refers to the 'top-level' Graph. It is the aggregation of all the contexts within it and is also the appropriate, absolute boundary for closed world assumptions / models. This distinction is the low-hanging fruit of RDF along the path to the semantic web and most of its value is in (corporate/enterprise) real-world problems: - -There are at least two situations where the closed world assumption is used. The first is where it is assumed that a knowledge base contains all relevant facts. This is common in corporate databases. That is, the information it contains is assumed to be complete - -From a store perspective, closed world assumptions also provide the benefit of better query response times due to the explicit closed world boundaries. Closed world boundaries can be made transparent by federated queries that assume each ConjunctiveGraph is a section of a larger, unbounded universe. So a closed world assumption does not preclude you from an open world assumption. - -For the sake of persistence, Conjunctive Graphs must be distinguished by identifiers (that may not necessarily be RDF identifiers or may be an RDF identifier normalized - SHA1/MD5 perhaps - for database naming purposes ) which could be referenced to indicate conjunctive queries (queries made across the entire conjunctive graph) or appear as nodes in asserted statements. In this latter case, such statements could be interpreted as being made about the entire 'known' universe. For example: - -<urn:uuid:conjunctive-graph-foo> rdf:type :ConjunctiveGraph - -<urn:uuid:conjunctive-graph-foo> rdf:type log:Truth - -<urn:uuid:conjunctive-graph-foo> :persistedBy :MySQL - -Terminology -^^^^^^^^^^^ - -``Conjunctive Query``: Any query that doesn't limit the store to search -within a named context only. Such a query expects a context-aware store to -search the entire asserted universe (the conjunctive graph). A formula-aware -store is expected not to include quoted statements when matching such a query. - diff --git a/docs/modules/graphs/dataset.rst b/docs/modules/graphs/dataset.rst deleted file mode 100644 index 0e2106ae..00000000 --- a/docs/modules/graphs/dataset.rst +++ /dev/null @@ -1,7 +0,0 @@ -:mod:`rdflib.graph.Dataset` -- Dataset -====================================== - - -.. autoclass:: rdflib.graph.Dataset - :members: - diff --git a/docs/modules/graphs/graph.rst b/docs/modules/graphs/graph.rst deleted file mode 100644 index 6734628a..00000000 --- a/docs/modules/graphs/graph.rst +++ /dev/null @@ -1,7 +0,0 @@ -:mod:`rdflib.graph.Graph` -- Graph -================================== - - -.. autoclass:: rdflib.graph.Graph - :members: - diff --git a/docs/modules/graphs/index.rst b/docs/modules/graphs/index.rst deleted file mode 100644 index 27e3656e..00000000 --- a/docs/modules/graphs/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _graphs: - -======= -Graphs -======= - -RDFLib defines the following kinds of Graphs: - -* Graph(**store**, **identifier**) -* QuotedGraph(**store**, **identifier**) -* ConjunctiveGraph(**store**, **default_identifier** = None) -* Dataset(**store**, **default_identifier** = None) - -Graph ------ -An RDF graph is a set of RDF triples. - -The set of nodes of an RDF graph is the set of subjects and objects of triples in the graph. - -.. toctree:: - :maxdepth: 2 - - graph - - -Conjunctive Graph ------------------ - -A Conjunctive Graph is the most relevant collection of graphs that are considered to be the boundary for closed world assumptions. This boundary is equivalent to that of the store instance (which is itself uniquely identified and distinct from other instances of :class:`Store` that signify other Conjunctive Graphs). It is equivalent to all the named graphs within it and associated with a ``_default_`` graph which is automatically assigned a :class:`BNode` for an identifier - if one isn't given. - -.. toctree:: - :maxdepth: 1 - - conjunctive_graph - - -Quoted graph ------------- - -The notion of an RDF graph [14] is extended to include the concept of a formula node. A formula node may occur wherever any other kind of node can appear. Associated with a formula node is an RDF graph that is completely disjoint from all other graphs; i.e. has no nodes in common with any other graph. (It may contain the same labels as other RDF graphs; because this is, by definition, a separate graph, considerations of tidiness do not apply between the graph at a formula node and any other graph.) - -This is intended to map the idea of "{ N3-expression }" that is used by N3 into an RDF graph upon which RDF semantics is defined. - -.. toctree:: - :maxdepth: 2 - - quoted_graph - -Dataset -------- - -The RDF 1.1 Dataset, a small extension to the Conjunctive Graph. The primary term is "graphs in the datasets" and not "contexts with quads" so there is a separate method to set/retrieve a graph in a dataset and to operate with dataset graphs. As a consequence of this approach, dataset graphs cannot be identified with blank nodes, a name is always required (RDFLib will automatically add a name if one is not provided at creation time). This implementation includes a convenience method to directly add a single quad to a dataset graph. - -.. toctree:: - :maxdepth: 2 - - dataset - - -Working with graphs -------------------- - -.. automodule:: rdflib.graph diff --git a/docs/modules/graphs/quoted_graph.rst b/docs/modules/graphs/quoted_graph.rst deleted file mode 100644 index eb739ec3..00000000 --- a/docs/modules/graphs/quoted_graph.rst +++ /dev/null @@ -1,11 +0,0 @@ -:mod:`rdflib.graph.QuotedGraph` -- Quoted graph -=============================================== - -RDFLib graphs support an additional extension of RDF semantics for formulae. For the academically inclined, Graham Kyles `formal extension`__ is probably a good read. - -.. __: http://ninebynine.org/RDFNotes/UsingContextsWithRDF.html#xtocid-6303976 - -Formulae are represented formally by the :class:`~rdflib.graph.QuotedGraph` class and are disjoint from regular RDF graphs in that their statements are quoted. - -.. autoclass:: rdflib.graph.QuotedGraph - :members: diff --git a/docs/modules/index.rst b/docs/modules/index.rst deleted file mode 100644 index 8e12334e..00000000 --- a/docs/modules/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _modules: - -======= -Modules -======= - -.. toctree:: - :maxdepth: 3 - - collection - events - graphs/index - namespace - node - parser - resource - result - serializer - statement - store - term - util diff --git a/docs/modules/namespace.rst b/docs/modules/namespace.rst deleted file mode 100644 index 85661041..00000000 --- a/docs/modules/namespace.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _rdflib.namespace: Namespace utils - -========= -Namespace -========= - -.. automodule:: rdflib.namespace - :members: - -.. autoclass:: rdflib.namespace.NamespaceManager - :members: - -.. autoclass:: rdflib.namespace.Namespace - :members: - -.. autofunction:: rdflib.namespace.split_uri diff --git a/docs/modules/node.rst b/docs/modules/node.rst deleted file mode 100644 index e0ee12b7..00000000 --- a/docs/modules/node.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _nodes: - -======= -Nodes -======= - -Nodes are a subset of the Terms that the underlying store actually persists. -The set of such Terms depends on whether or not the store is formula-aware. -Stores that aren't formula-aware would only persist those terms core to the -RDF Model, and those that are formula-aware would be able to persist the N3 -extensions as well. However, utility terms that only serve the purpose for -matching nodes by term-patterns probably will only be terms and not nodes. - -The set of nodes of an RDF graph is the set of subjects and objects of triples in the graph. - -The RDFLib classes listed below model RDF `terms`__ in a graph and inherit from a common `Identifier`_ class, which extends Python unicode. Instances of these are nodes in an RDF graph. - -.. automodule:: rdflib.term - -.. autoclass:: rdflib.term.Node - :members: - -.. autoclass:: rdflib.term.Identifier - :members: - -.. autoclass:: rdflib.term.BNode - :members: - -.. autoclass:: rdflib.term.URIRef - :members: - -.. autoclass:: rdflib.term.Literal - :members: - -.. autoclass:: rdflib.term.Variable - :members: - - -.. __: univrdfstore.html#Terms -.. _Identifier: http://www.w3.org/2002/07/rdf-identifer-terminology/ diff --git a/docs/modules/parser.rst b/docs/modules/parser.rst deleted file mode 100644 index b70be5e4..00000000 --- a/docs/modules/parser.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _rdflib.parser: Parser - - -============= -Parser -============= - -.. automodule:: rdflib.parser -.. :noindex: -.. autofunction:: rdflib.parser.create_input_source - -.. autoclass:: rdflib.parser.Parser - :members: - -.. autoclass:: rdflib.parser.InputSource - :members: - -.. autoclass:: rdflib.parser.StringInputSource - :members: - -.. autoclass:: rdflib.parser.URLInputSource - :members: - -.. autoclass:: rdflib.parser.FileInputSource - :members: - diff --git a/docs/modules/resource.rst b/docs/modules/resource.rst deleted file mode 100644 index 848d47eb..00000000 --- a/docs/modules/resource.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _resource: - -Resource --------- -.. automodule:: rdflib.resource -.. :noindex: - diff --git a/docs/modules/result.rst b/docs/modules/result.rst deleted file mode 100644 index aa59e7cb..00000000 --- a/docs/modules/result.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. rdflib.query.result: Result - -====== -Result -====== -.. automodule:: rdflib.query -.. :noindex: -.. autoclass:: rdflib.query.Result - :members: - diff --git a/docs/modules/serializer.rst b/docs/modules/serializer.rst deleted file mode 100644 index 038b64ff..00000000 --- a/docs/modules/serializer.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. rdflib.serializer: Serializer - -=========== -Serializer -=========== - -.. automodule:: rdflib.serializer -.. :noindex: -.. autoclass:: rdflib.serializer.Serializer - :members: - - diff --git a/docs/modules/statement.rst b/docs/modules/statement.rst deleted file mode 100644 index 63879075..00000000 --- a/docs/modules/statement.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _rdflib.statement: Other modules - -========= -Statement -========= - -.. currentmodule:: rdflib.term -.. :noindex: -.. autoclass:: rdflib.term.Statement -.. automethod:: rdflib.term.Statement.__new__ -.. automethod:: rdflib.term.Statement.__reduce__ - - diff --git a/docs/modules/store.rst b/docs/modules/store.rst deleted file mode 100644 index 9ccd0451..00000000 --- a/docs/modules/store.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _rdflib.store: Other modules - - -Store ------ -.. automodule:: rdflib.store -.. :noindex: - -.. autoclass:: rdflib.store.Store - :members: - -Events -^^^^^^ - -.. autoclass:: rdflib.store.StoreCreatedEvent - :members: - -.. autoclass:: rdflib.store.TripleAddedEvent - :members: - -.. autoclass:: rdflib.store.TripleRemovedEvent - :members: - diff --git a/docs/modules/term.rst b/docs/modules/term.rst deleted file mode 100644 index 986c0724..00000000 --- a/docs/modules/term.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _rdflib.term: Terms - -========= -Term -========= - -.. currentmodule:: rdflib.term -.. :noindex: -.. automodule:: rdflib.term - :members: - :noindex: - -.. currentmodule:: rdflib.term -.. _Seq: -.. autoclass:: rdflib.graph.Seq - :members: - -.. _QuotedGraph: -.. autoclass:: rdflib.graph.QuotedGraph - :noindex: - -.. _ReadOnlyGraphAggregate: -.. autoclass:: rdflib.graph.ReadOnlyGraphAggregate - :noindex: diff --git a/docs/modules/util.rst b/docs/modules/util.rst deleted file mode 100644 index 6eb9c32a..00000000 --- a/docs/modules/util.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _rdflib.util: Utilities - -========= -Utilities -========= - -.. currentmodule:: rdflib.util - -Miscellaneous utilities ------------------------ - -.. autofunction:: rdflib.util.list2set -.. autofunction:: rdflib.util.first -.. autofunction:: rdflib.util.uniq -.. autofunction:: rdflib.util.more_than - -Term characterisation and generation -------------------------------------- - -.. autofunction:: rdflib.util.to_term -.. autofunction:: rdflib.util.from_n3 - - -Statement and component type checkers -------------------------------------- - -.. autofunction:: rdflib.util.check_context -.. autofunction:: rdflib.util.check_subject -.. autofunction:: rdflib.util.check_predicate -.. autofunction:: rdflib.util.check_object -.. autofunction:: rdflib.util.check_statement -.. autofunction:: rdflib.util.check_pattern - -Date/time utilities -------------------- - -.. autofunction:: rdflib.util.date_time -.. autofunction:: rdflib.util.parse_date_time |
