[moriarty] r242 committed - Updated documentation
mori...@googlecode.com
Author: innovateer
Date: Wed Jan 13 06:40:33 2010
Log: Updated documentation
http://code.google.com/p/moriarty/source/detail?r=242
Modified:
/wiki/ChangeSet.wiki
/wiki/ChangeSetBatch.wiki
/wiki/ClassList.wiki
/wiki/CurlHttpClient.wiki
/wiki/GraphPath.wiki
/wiki/HttpResponse.wiki
/wiki/JobQueue.wiki
/wiki/Labeller.wiki
/wiki/ResourceList.wiki
/wiki/Rollback.wiki
/wiki/SimpleGraph.wiki
/wiki/Snapshots.wiki
/wiki/StoreCollection.wiki
/wiki/Union.wiki
/wiki/ValuePool.wiki
=======================================
--- /wiki/ChangeSet.wiki Wed Jan 13 06:13:50 2010
+++ /wiki/ChangeSet.wiki Wed Jan 13 06:40:33 2010
@@ -19,7 +19,7 @@
== Constructors ==
* [#ChangeSet ChangeSet]
== Methods ==
- * [#addT addT] - addT adds a triple to the internal simpleIndex holding
all the changesets and statements
+ * [#addT addT] - adds a triple to the internal simpleIndex holding all
the changesets and statements
* [#has_changes has_changes]
* [#toRDFXML toRDFXML]
* [#to_rdfxml to_rdfxml] - Serialise the graph to RDF/XML
@@ -81,17 +81,9 @@
== Fields ==
* [#a $a] - Serialise the graph to RDF/XML
* [#after $after] - Serialise the graph to RDF/XML
- * [#after_rdfxml $after_rdfxml] - Serialise the graph to RDF/XML
* [#before $before] - Serialise the graph to RDF/XML
- * [#before_rdfxml $before_rdfxml] - Serialise the graph to RDF/XML
- * [#changeReason $changeReason] - Serialise the graph to RDF/XML
- * [#createdDate $createdDate] - Serialise the graph to RDF/XML
- * [#creatorName $creatorName] - Serialise the graph to RDF/XML
- * [#cs_resource $cs_resource] - Serialise the graph to RDF/XML
- * [#has_changes $has_changes] - Serialise the graph to RDF/XML
- * [#include_count $include_count] - Serialise the graph to RDF/XML
* [#subjectIndex $subjectIndex] - Serialise the graph to RDF/XML
- * [#subjectOfChange $subjectOfChange] - Serialise the graph to RDF/XML
+
= Constructor Detail =
== ChangeSet ==
@@ -110,7 +102,6 @@
public void addT(mixed s, mixed p, mixed o, mixed o_type)
}}}
-addT
adds a triple to the internal simpleIndex holding all the changesets and
statements<dl>
<dt>Return:</dt>
<dd>void</dd>
@@ -186,14 +177,6 @@
{{{
public mixed $after = array()
}}}
-
-
-
-== after_rdfxml ==
-
-{{{
-protected mixed $after_rdfxml
-}}}
@@ -202,62 +185,6 @@
{{{
public mixed $before = array()
}}}
-
-
-
-== before_rdfxml ==
-
-{{{
-protected mixed $before_rdfxml
-}}}
-
-
-
-== changeReason ==
-
-{{{
-protected mixed $changeReason = null
-}}}
-
-
-
-== createdDate ==
-
-{{{
-protected mixed $createdDate = null
-}}}
-
-
-
-== creatorName ==
-
-{{{
-protected mixed $creatorName = null
-}}}
-
-
-
-== cs_resource ==
-
-{{{
-protected mixed $cs_resource = null
-}}}
-
-
-
-== has_changes ==
-
-{{{
-protected mixed $has_changes = false
-}}}
-
-
-
-== include_count ==
-
-{{{
-protected mixed $include_count
-}}}
@@ -266,14 +193,6 @@
{{{
public mixed $subjectIndex = array()
}}}
-
-
-
-== subjectOfChange ==
-
-{{{
-protected mixed $subjectOfChange
-}}}
=======================================
--- /wiki/ChangeSetBatch.wiki Wed Jan 13 01:00:06 2010
+++ /wiki/ChangeSetBatch.wiki Wed Jan 13 06:40:33 2010
@@ -26,6 +26,7 @@
* [#before $before]
* [#subjectIndex $subjectIndex]
* [#utils $utils]
+
= Constructor Detail =
== ChangeSetBatch ==
=======================================
--- /wiki/ClassList.wiki Wed Jan 13 06:10:09 2010
+++ /wiki/ClassList.wiki Wed Jan 13 06:40:33 2010
@@ -2,11 +2,7 @@
#labels Featured
* [GraphPath] - EXPERIMENTAL: Represents a path selecting nodes from a
simple graph.
- * [AndExpr] -
- * [AnyLiteralMatcher] -
* [AugmentService] - Represents a store's augment service
- * [BooleanFunction] -
- * [BooleanGenerator] -
* [SimpleGraph] - Represents an RDF graph and provides some simple
functions for traversing and manipulating it.
* [ChangeSet] - Represents a changeset.
* [NetworkResource] - Represents a simple data resource that exists on
the network.
@@ -15,18 +11,14 @@
* [StoreGroup] - Represents a group of stores.
* [StoreCollection] - Represents the collection of all platform stores.
* [ChangeSetBatch] - Represents a batch of changesets.
- * [CompExpr] -
* [Config] - A helper class to assist with configuring a store.
* [Contentbox] - Represents a store's contentbox
- * [Converter] - Implements FSL specific conversions
- * [CountFunction] -
* [Credentials] - Represents a username and password pair for
authenticating against secure services.
* [HttpClient]
* [CurlHttpClient] - A CURL based http client implementation.
* [PhpHttpClient] - A CURL based http client implementation.
* [DataTable] - DataTable is Moriarty's implementation of the Active
Record pattern for RDF data.
* [DataTableResult]
- * [ExpFunction] -
* [FacetService] - Represents a store's facet service.
* [Graph] - The base class for graphs in a store.
* [Metabox] - Represents a store's metabox.
@@ -37,34 +29,17 @@
* [HttpResponse] - Represents an HTTP protocol response.
* [JobQueue] - Represents a store's job queue
* [Labeller] - Utility class for labelling properties
- * [LiteralDtFunction] -
- * [LiteralGenerator] -
- * [LiteralMatcher] -
- * [LiteralValueFunction] -
- * [LocalNameFunction] -
* [SparqlServiceBase] - Represents the base class for various sparql
services.
* [MultiSparqlService] - Represents a store's multi sparql service
* [SparqlService] - Represents a store's sparql service
- * [NamespaceUriFunction] -
- * [NormalizeSpaceFunction] -
- * [NumberGenerator] -
- * [NumberMatcher] -
* [OAIService] - Represents a store's OAI-PMH service
- * [OrExpr] -
- * [Path] -
* [ResourceList] - Represents a list of resources returned from a
contentbox search.
* [Rollback]
- * [SelfGenerator] -
* [Snapshots]
- * [StepMatcher] -
* [Store] - Represents a platform store.
* [StoreGroupConfig] - A helper class to assist with configuring store
groups.
- * [StringLengthFunction] -
- * [TypeMatcher] -
* [Union] - Represents a virtual union of multiple stores
- * [UriFunction] -
* [ValuePool] - Deprecated
- * [WildCardMatcher] -
Generated by [http://phpdoctor.sourceforge.net/ PHPDoctor 2RC2]
=======================================
--- /wiki/CurlHttpClient.wiki Fri Jan 8 00:56:36 2010
+++ /wiki/CurlHttpClient.wiki Wed Jan 13 06:40:33 2010
@@ -10,8 +10,6 @@
* [#CurlHttpClient CurlHttpClient]
== Methods ==
* [#get_response_for get_response_for]
- * [#parse_response parse_response] -
- * [#processCurlMessage processCurlMessage]
* [#send_request send_request]
== Methods inherited from Moriarty.HttpClient ==
@@ -36,22 +34,6 @@
{{{
public void get_response_for(mixed key, mixed request)
}}}
-
-
-
-== parse_response ==
-
-{{{
-private void parse_response(mixed response)
-}}}
-
-
-
-== processCurlMessage ==
-
-{{{
-private void processCurlMessage(mixed done)
-}}}
=======================================
--- /wiki/GraphPath.wiki Wed Jan 13 06:10:09 2010
+++ /wiki/GraphPath.wiki Wed Jan 13 06:40:33 2010
@@ -12,34 +12,9 @@
== Constructors ==
* [#GraphPath GraphPath]
== Methods ==
- * [#add_error add_error] -
* [#get_errors get_errors]
* [#has_errors has_errors]
- * [#m m] -
- * [#m_andexpr m_andexpr] -
- * [#m_axis m_axis] -
- * [#m_booleangenerator m_booleangenerator] -
- * [#m_closebracket m_closebracket] -
- * [#m_compexpr m_compexpr] -
- * [#m_functioncall m_functioncall] -
- * [#m_literal m_literal] -
- * [#m_literalgenerator m_literalgenerator] -
- * [#m_locationpath m_locationpath] -
- * [#m_number m_number] -
- * [#m_numbergenerator m_numbergenerator] -
- * [#m_oneargument m_oneargument] -
- * [#m_openbracket m_openbracket] -
- * [#m_operator m_operator] -
- * [#m_orexpr m_orexpr] -
- * [#m_slash m_slash] -
- * [#m_split m_split] -
- * [#m_step m_step] -
- * [#m_string m_string] -
- * [#m_test m_test] -
- * [#m_textfunction m_textfunction] -
- * [#m_unaryexpr m_unaryexpr] -
* [#match match] - Evaluate the path against a graph
- * [#to_string to_string] -
= Constructor Detail =
@@ -53,14 +28,6 @@
= Method Detail =
-== add_error ==
-
-{{{
-private void add_error(mixed err)
-}}}
-
-
-
== get_errors ==
{{{
@@ -74,190 +41,6 @@
{{{
public void has_errors()
}}}
-
-
-
-== m ==
-
-{{{
-private void m(mixed re, mixed v, mixed options)
-}}}
-
-
-
-== m_andexpr ==
-
-{{{
-private void m_andexpr(mixed v)
-}}}
-
-
-
-== m_axis ==
-
-{{{
-private void m_axis(mixed v)
-}}}
-
-
-
-== m_booleangenerator ==
-
-{{{
-private void m_booleangenerator(mixed v)
-}}}
-
-
-
-== m_closebracket ==
-
-{{{
-private void m_closebracket(mixed v)
-}}}
-
-
-
-== m_compexpr ==
-
-{{{
-private void m_compexpr(mixed v)
-}}}
-
-
-
-== m_functioncall ==
-
-{{{
-private void m_functioncall(mixed v)
-}}}
-
-
-
-== m_literal ==
-
-{{{
-private void m_literal(mixed v)
-}}}
-
-
-
-== m_literalgenerator ==
-
-{{{
-private void m_literalgenerator(mixed v)
-}}}
-
-
-
-== m_locationpath ==
-
-{{{
-private void m_locationpath(mixed v)
-}}}
-
-
-
-== m_number ==
-
-{{{
-private void m_number(mixed v)
-}}}
-
-
-
-== m_numbergenerator ==
-
-{{{
-private void m_numbergenerator(mixed v)
-}}}
-
-
-
-== m_oneargument ==
-
-{{{
-private void m_oneargument(mixed v)
-}}}
-
-
-
-== m_openbracket ==
-
-{{{
-private void m_openbracket(mixed v)
-}}}
-
-
-
-== m_operator ==
-
-{{{
-private void m_operator(mixed v)
-}}}
-
-
-
-== m_orexpr ==
-
-{{{
-private void m_orexpr(mixed v)
-}}}
-
-
-
-== m_slash ==
-
-{{{
-private void m_slash(mixed v)
-}}}
-
-
-
-== m_split ==
-
-{{{
-private void m_split(mixed pattern, mixed v)
-}}}
-
-
-
-== m_step ==
-
-{{{
-private void m_step(mixed v)
-}}}
-
-
-
-== m_string ==
-
-{{{
-private void m_string(mixed v)
-}}}
-
-
-
-== m_test ==
-
-{{{
-private void m_test(mixed v)
-}}}
-
-
-
-== m_textfunction ==
-
-{{{
-private void m_textfunction(mixed v)
-}}}
-
-
-
-== m_unaryexpr ==
-
-{{{
-private void m_unaryexpr(mixed v)
-}}}
@@ -275,14 +58,6 @@
</dl>
-== to_string ==
-
-{{{
-private void to_string()
-}}}
-
-
-
Generated by [http://phpdoctor.sourceforge.net/ PHPDoctor 2RC2]
=======================================
--- /wiki/HttpResponse.wiki Wed Jan 13 01:00:06 2010
+++ /wiki/HttpResponse.wiki Wed Jan 13 06:40:33 2010
@@ -20,6 +20,7 @@
* [#info $info] - Obtain a string representation of this response
* [#request $request] - Obtain a string representation of this response
* [#status_code $status_code] - Obtain a string representation of this
response
+
= Constructor Detail =
== HttpResponse ==
=======================================
--- /wiki/JobQueue.wiki Wed Jan 13 01:00:06 2010
+++ /wiki/JobQueue.wiki Wed Jan 13 06:40:33 2010
@@ -14,8 +14,6 @@
* [#JobQueue JobQueue] - Create a new instance of this class
== Methods ==
* [#get_item_uris get_item_uris] - Get a list of URIs of jobs that have
been scheduled.
- * [#make_job_request make_job_request] -
- * [#schedule_job schedule_job] -
* [#schedule_reindex schedule_reindex] - Schedule a reindex data job in
the queue
* [#schedule_reset_data schedule_reset_data] - Schedule a reset data job
in the queue
* [#schedule_restore schedule_restore] - Schedule a restore data job in
the queue
@@ -50,22 +48,6 @@
</dl>
-== make_job_request ==
-
-{{{
-private void make_job_request(mixed jobtype, mixed time, mixed label)
-}}}
-
-
-
-== schedule_job ==
-
-{{{
-private void schedule_job(mixed job)
-}}}
-
-
-
== schedule_reindex ==
{{{
=======================================
--- /wiki/Labeller.wiki Wed Jan 13 06:13:50 2010
+++ /wiki/Labeller.wiki Wed Jan 13 06:40:33 2010
@@ -18,8 +18,7 @@
* [#uri_to_qname uri_to_qname] - Convert a URI to a QName using
registered namespace prefixes
== Fields ==
- * [#_label_properties $_label_properties] - Convert a URI to a QName
using registered namespace prefixes
- * [#_ns $_ns] - Convert a URI to a QName using registered namespace
prefixes
+
= Method Detail =
== add_labelling_property ==
@@ -113,23 +112,6 @@
= Field Detail =
-== _label_properties ==
-
-{{{
-protected mixed $_label_properties = array()
-}}}
-
-
-
-== _ns ==
-
-{{{
-protected mixed $_ns = array (
- 'rdfs' => 'http://www.w3.org/2000/01/rdf-schema#'
-}}}
-
-
-
Generated by [http://phpdoctor.sourceforge.net/ PHPDoctor 2RC2]
=======================================
--- /wiki/ResourceList.wiki Fri Jan 8 00:56:36 2010
+++ /wiki/ResourceList.wiki Wed Jan 13 06:40:33 2010
@@ -13,6 +13,7 @@
* [#start_index $start_index] - Represents a list of resources returned
from a contentbox search.
* [#title $title] - Represents a list of resources returned from a
contentbox search.
* [#total_results $total_results] - Represents a list of resources
returned from a contentbox search.
+
= Field Detail =
== description ==
=======================================
--- /wiki/Rollback.wiki Wed Jan 13 01:00:06 2010
+++ /wiki/Rollback.wiki Wed Jan 13 06:40:33 2010
@@ -13,6 +13,7 @@
== Fields ==
* [#sparqlservice $sparqlservice] - to_changeset
+
= Constructor Detail =
== Rollback ==
=======================================
--- /wiki/SimpleGraph.wiki Wed Jan 13 06:13:50 2010
+++ /wiki/SimpleGraph.wiki Wed Jan 13 06:40:33 2010
@@ -34,7 +34,6 @@
* [#get_subject_subgraph get_subject_subgraph] - Fetch a subgraph where
all triples have given subject
* [#get_subjects get_subjects] - Fetch an array of all the subjects
* [#get_subjects_of_type get_subjects_of_type] - Fetch an array of all
the subject that have and rdf type that matches that given
- * [#get_subjects_where get_subjects_where]
* [#get_subjects_where_literal get_subjects_where_literal] - Fetch an
array of all the subjects where the predicate and object match a ?s $p $o
triple in the graph and the object is a literal value
* [#get_subjects_where_resource get_subjects_where_resource] - Fetch an
array of all the subjects where the predicate and object match a ?s $p $o
triple in the graph and the object is a resource
* [#get_triples get_triples] -
@@ -63,7 +62,7 @@
* [#uri_to_qname uri_to_qname] - Convert a URI to a QName using
registered namespace prefixes
== Fields ==
- * [#_ns $_ns] - Convert a URI to a QName using registered namespace
prefixes
+
= Constructor Detail =
== SimpleGraph ==
@@ -414,14 +413,6 @@
</dl>
-== get_subjects_where ==
-
-{{{
-private void get_subjects_where(mixed p, mixed o, mixed type)
-}}}
-
-
-
== get_subjects_where_literal ==
{{{
@@ -756,15 +747,6 @@
= Field Detail =
-== _ns ==
-
-{{{
-protected mixed $_ns = array (
- 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'
-}}}
-
-
-
Generated by [http://phpdoctor.sourceforge.net/ PHPDoctor 2RC2]
=======================================
--- /wiki/Snapshots.wiki Wed Jan 13 01:00:06 2010
+++ /wiki/Snapshots.wiki Wed Jan 13 06:40:33 2010
@@ -14,6 +14,7 @@
* [#credentials $credentials] - get_snapshots
* [#errors $errors] - get_snapshots
* [#uri $uri] - get_snapshots
+
= Constructor Detail =
== Snapshots ==
=======================================
--- /wiki/StoreCollection.wiki Wed Jan 13 06:13:50 2010
+++ /wiki/StoreCollection.wiki Wed Jan 13 06:40:33 2010
@@ -15,7 +15,6 @@
== Methods ==
* [#create_store create_store] - Create a new store on the platform.
* [#get_store_uris get_store_uris] - Obtain the list of store URIs.
- * [#retrieve retrieve] -
== Methods inherited from Moriarty.SimpleGraph ==
@@ -115,18 +114,6 @@
</dl>
-== retrieve ==
-
-{{{
-private void retrieve()
-}}}
-
-<dl>
-<dt>Deprecated:</dt>
-<dd>this should be compatible with NetworkResource</dd>
-</dl>
-
-
Generated by [http://phpdoctor.sourceforge.net/ PHPDoctor 2RC2]
=======================================
--- /wiki/Union.wiki Fri Jan 8 00:56:36 2010
+++ /wiki/Union.wiki Wed Jan 13 06:40:33 2010
@@ -12,6 +12,7 @@
== Fields ==
* [#stores $stores]
+
= Method Detail =
== add ==
=======================================
--- /wiki/ValuePool.wiki Fri Jan 8 00:56:36 2010
+++ /wiki/ValuePool.wiki Wed Jan 13 06:40:33 2010
@@ -18,6 +18,7 @@
== Fields ==
* [#bigfootMetabox $bigfootMetabox]
* [#bigfootSparqlService $bigfootSparqlService]
+
= Method Detail =
== get_candidate_values ==