Differences between revisions 2 and 9 (spanning 7 versions)

Fedora Resource Index

The Fedora Resource Index service is described in http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index

The resource index is queried by iTQL. A guide to iTQL can be found on http://docs.mulgara.org/itqlcommands/select.html

This has a graphical user interface, which it very helpful to users, but not programmatically useful. The interface is described here:

http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search

For programs, there are two interfaces.

The first is the REST-based interface defined in
http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search#ResourceIndexSearch-ApplicationInterface
The second is the Fedora client, which has a method getTuples(). See
http://www.fedora-commons.org/documentation/3.0/javadocs/index.html?fedora/client/FedoraClient.html.
The method getTuples() has the following javadoc
```
    /**
     * Get tuples from the remote resource index. The map contains
     * <em>String</em> values for parameters that should be passed to the
     * service. Two parameters are required: 1) lang 2) query Two parameters to
     * the risearch service are implied: 1) type = tuples 2) format = sparql See
     * http://www.fedora.info/download/2.0/userdocs/server/webservices/risearch/#app.tuples
     */
```
which is unfortunately outdated.
The method returns an org.trippi.TupleIterator which parses the sparql result. The javadoc for this can be found on http://trippi.sourceforge.net/api/org/trippi/TupleIterator.html
Note that the page is not updated either, the releases can be found in the svn, and has reached version 1.4. Fedora uses 1.3.2, which is unknown, but 1.3.1 can be checked out. Look at http://sourceforge.net/svn/?group_id=123675 to do this. The result consist of a list of maps. The iterator iterates through this list, returning maps. The iterator has a method, names, giving the keys to each map. The values in the maps are of type Node, see
http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Node.html In practice each node will always be a Literal node or a URI reference Node or a Blank node, see the following
http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Literal.html,
http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/URIReference.html,
http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/BlankNode.html

-  ⇤ ← Revision 2 as of 2008-10-16 12:15:29 → 
  Size: 2363
  Editor: jrg
  Comment:
+   ← Revision 9 as of 2008-10-17 08:29:58 → ⇥
  Size: 2499
  Editor: jrg
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
-You have the resource index service, described in
http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index
+The Fedora Resource Index service is described in http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index
-Line 6:
+Line 5:
-The resource index is queried by iTQL. A guide to itql can be found on http://docs.mulgara.org/itqlcommands/select.html
+The resource index is queried by iTQL. A guide to iTQL can be found on http://docs.mulgara.org/itqlcommands/select.html
-Line 8:
+Line 7:
-This has a graphical user interface, which it very helpful to users, but not programmatically useful. http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search
+This has a graphical user interface, which it very helpful to users, but not programmatically useful. The interface is described here:
-Line 10:
+Line 9:
-For programs, there are two interfaces, both not very optimal.
+http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search
-Line 12:
+Line 11:
-The first is the rest based interface, defined in http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search#ResourceIndexSearch-ApplicationInterface
+For programs, there are two interfaces.
-Line 14:
+Line 13:
-The second in the fedora client, which has a getTuples method. http://www.fedora-commons.org/documentation/3.0/javadocs/index.html?fedora/client/FedoraClient.html. It has the javadoc
+ * The first is the REST-based interface defined in
-Line 16:
+Line 15:
-{{{
+ http://www.fedora-commons.org/confluence/display/FCR30/Resource+Index+Search#ResourceIndexSearch-ApplicationInterface

 * The second is the Fedora client, which has a method {{{getTuples()}}}. See

 http://www.fedora-commons.org/documentation/3.0/javadocs/index.html?fedora/client/FedoraClient.html.

 The method {{{getTuples()}}} has the following javadoc

 {{{
-Line 24:
+Line 31:
-}}} which is nicely outdated.
This method, returns an org.trippi.TupleIterator which parses the sparql result. The javadoc for this can be found on 
http://trippi.sourceforge.net/api/org/trippi/TupleIterator.html Note that the page is not updated either, the releases can be found in the svn, and has reached version 1.4. Fedora use 1.3.2, which is unknown, but 1.3.1 can be checked out. Look at  http://sourceforge.net/svn/?group_id=123675 to od this.
+ }}} which is unfortunately outdated.
-Line 28:
+Line 33:
-The result consist of a list of maps. The iterator iterates through this list, returning maps. The iterator has a method, names, giving the keys to each map. The values in the maps are of type Node, http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Node.html
+ The method returns an {{{org.trippi.TupleIterator}}} which parses the sparql result. The javadoc for this can be found on 
 http://trippi.sourceforge.net/api/org/trippi/TupleIterator.html
-Line 30:
+Line 36:
-In practice each node will always be a Literal node or a URI reference Node or a Blank node, http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/URIReference.html, http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Literal.html , http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/BlankNode.html
+ Note that the page is not updated either, the releases can be found in the svn, and has reached version 1.4. Fedora uses 1.3.2, which is unknown, but 1.3.1 can be checked out. Look at  http://sourceforge.net/svn/?group_id=123675 to do this.
-Line 32:
+Line 38:
+ The result consist of a list of maps. The iterator iterates through this list, returning maps. The iterator has a method, names, giving the keys to each map. The values in the maps are of type Node, see
 http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Node.html
 
 In practice each node will always be a Literal node or a URI reference Node or a Blank node, see the following
 
 http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/Literal.html,

 http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/URIReference.html,

 http://jrdf.sourceforge.net/0.3.4/doc/javadoc/org/jrdf/graph/BlankNode.html