Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Move the readme to the markdown format for github.

  • Loading branch information...
commit 0aa9c13c947c92825a277d1d10fe6e4f380a6ec5 1 parent 7a9b209
Elliott Johnson authored
Showing with 88 additions and 11 deletions.
  1. +88 −11 readme.txt → README.md
View
99 readme.txt → README.md
@@ -1,10 +1,37 @@
-Welcome to AllegroGraph C# Client
+agraph-csharp-client: A C# client for AllegroGraph
+==================================================
+
+Table of contents
+-----------------
+
+ * Description
+ * Author
+ * Documentation
+ * Platforms
+ * Dependencies
+ * Installation
+ * Configuration
+ * Licence
+ * Notes
+ * Examples
+ * Franz Inc. Open Source Info
+
+Description
+-----------
This library is an C# version of the core java library for
programmatically interacting with the AllegroGraph, from Franz, Inc.
This is the initial version of the library, and additional features
will be added over time.
+Author
+------
+
+Steve Paplanus, <steve_paplanus@spatial.redlands.edu>
+
+Author Comments
+---------------
+
The purpose of this library was to fill a major requirement for
projects that I work on, which is that they need to be .NET
compatible. I have decided to implement it so that it is both a
@@ -14,7 +41,7 @@ utilized in a more SOA type of environment via WCF. Whether it ever
will get to the latter SOA use, who knows. However, it was very easy
to implement.
-The client is is freely to use it in your projects. My request is
+The client is free to use in your projects. My request is
that if you find bugs or wish to ask for enhancements, that you either
email me with the information or the fix. The client, in its current
form, has the ability to create and get information about catalogs,
@@ -23,6 +50,42 @@ queries. Future versions will complete the stub functions for the
create, update, and deletion of actual statements inside the
repository.
+Platforms
+----------
+
+Windows 2000/XP/Vista/Server2003 32/64bit or Linux 32/64 bit
+
+Dependencies
+------------
+
+MS .NET framework or mono.
+
+Installation
+------------
+
+TODO - Add documentation on how to install this project
+
+Configuration
+-------------
+
+TODO - Add documentation on how to configure this project once installed
+
+Documentation
+-------------
+
+TODO - Add content or links to documentation on how to use this project.
+
+License
+-------
+
+The agraph-csharp-client source code is licensed under the terms of the
+[Lisp Lesser GNU Public License](http://opensource.franz.com/preamble.html),
+known as the LLGPL. The LLGPL consists of a preamble and the LGPL. Where these
+conflict, the preamble takes precedence. This project is referenced in the
+preamble as the LIBRARY.
+
+Notes
+-----
There are four main classes that make up the library. I have included
a basic JSON utility class that takes the results from a query, which
@@ -35,21 +98,19 @@ which handles displaying the statements in your ontology as well as
exposes the query functionality. You will typically initialize a
repository object like this:
- AllegroGraphCSharpClient.Repository rep =
- new AllegroGraphCSharpClient.Repository(@"http://webserv:8000/catalogs/Test/repositories/Tools");
+ AllegroGraphCSharpClient.Repository rep = new AllegroGraphCSharpClient.Repository(@"http://webserv:8000/catalogs/Test/repositories/Tools");
where the Repository object expects you to initialize with the url of
the allegrograph repository in the format of:
- http://<web server name>:<http port for allegrograph>/catalogs/<repository Name>/repositories/<ontology>
-
+ http://<web server name>:<http port for allegrograph>/catalogs/<repository Name>/repositories/<ontology>
You can then create a results object, which is what every function
returns either a single AllegroGraphCSharpClientResults object or a
List<AllegroGraphCSharpClient.Results>. For example, to create a List
of Results the following syntax:
- List<AllegroGraphCSharpClient.Results> results = new List<AllegroGraphCSharpClient.Results>();
+ List<AllegroGraphCSharpClient.Results> results = new List<AllegroGraphCSharpClient.Results>();
This results object has a single property, a string called "result".
I have added to both evalSparqlQuery and evalPrologQuery a parameter
@@ -57,13 +118,13 @@ called AdditionalPrefixes, which allows you to define additional
references that your ontology references. An example string would
look like:
-"PREFIX fn:<http://www.w3.org/2005/xpath-functions#> PREFIX bio:<http://purl.org/vocab/bio/0.1/>"
+ PREFIX fn:<http://www.w3.org/2005/xpath-functions#> PREFIX bio:<http://purl.org/vocab/bio/0.1/>
+
which defines two namespaces fn and bio.
To find additional information about the function calls, you can look
-at Franz's documentation at:
-
-http://www.franz.com/agraph/support/documentation/current/http-protocol.html.
+at [Franz's documentation]
+(http://www.franz.com/agraph/support/documentation/current/http-protocol.html.)
Another class is the catalog class, which is a basic class that will
return information about a catalog, list the statements within a
@@ -72,3 +133,19 @@ catalog, create a catalog, and delete a catalog.
The final class, a low level class, called Request, handles all the
REST interaction between the server and the client, including the
relevant GET/PUT/POST/DELETE statements.
+
+Examples and Information
+------------------------
+
+See the notes section above.
+
+Franz Open Source Info
+----------------------
+
+This project's homepage is <http://opensource.franz.com>. There is an
+informal community support and development mailing list
+[opensource@franz.com](http://opensource.franz.com/mailinglist.html)
+for these open source projects. We encourage you to take advantage by
+subscribing to the list. Once you're subscribed, email to
+<opensource@franz.com> with your questions, comments, suggestions,
+and patches.
Please sign in to comment.
Something went wrong with that request. Please try again.