[Bigdata-commit] SF.net SVN: bigdata:[4029] branches/JOURNAL_HA_BRANCH/bigdata-rdf/src/java/ com/bigdata/rdf/store/BD.java

[<mrp...@us...>]

Revision: 4029
          http://bigdata.svn.sourceforge.net/bigdata/?rev=4029&view=rev
Author:   mrpersonick
Date:     2010-12-21 15:13:44 +0000 (Tue, 21 Dec 2010)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    branches/JOURNAL_HA_BRANCH/bigdata-rdf/src/java/com/bigdata/rdf/store/BD.java

Modified: branches/JOURNAL_HA_BRANCH/bigdata-rdf/src/java/com/bigdata/rdf/store/BD.java
===================================================================
--- branches/JOURNAL_HA_BRANCH/bigdata-rdf/src/java/com/bigdata/rdf/store/BD.java	2010-12-21 15:09:07 UTC (rev 4028)
+++ branches/JOURNAL_HA_BRANCH/bigdata-rdf/src/java/com/bigdata/rdf/store/BD.java	2010-12-21 15:13:44 UTC (rev 4029)
@@ -65,6 +65,14 @@
      */
     final String NAMESPACE = "http://www.bigdata.com/rdf#";
     
+    /**
+     * The namespace used for magic search predicates.
+     * <p>
+     * @see #SEARCH
+     * @see #RELEVANCE
+     * @see #RANK
+     * @see #NUM_MATCHED_TOKENS
+     */
     final String SEARCH_NAMESPACE = "http://www.bigdata.com/rdf/search#";
     
     /**
@@ -154,10 +162,52 @@
      */
     final URI SEARCH = new URIImpl(SEARCH_NAMESPACE+"search");
     
+    /**
+     * Magic predicate used to query for free text search metadata.  Use 
+     * in conjunction with {@link #SEARCH} as follows:
+     * <p>
+     * <pre>
+     * 
+     * select ?s ?relevance
+     * where {
+     *   ?s bd:search &quot;scale-out RDF triplestore&quot; .
+     *   ?s bd:relevance ?relevance .
+     * }
+     * 
+     * </pre>
+     */
     final URI RELEVANCE = new URIImpl(SEARCH_NAMESPACE+"relevance");
     
+    /**
+     * Magic predicate used to query for free text search metadata.  Use 
+     * in conjunction with {@link #SEARCH} as follows:
+     * <p>
+     * <pre>
+     * 
+     * select ?s ?rank
+     * where {
+     *   ?s bd:search &quot;scale-out RDF triplestore&quot; .
+     *   ?s bd:rank ?rank .
+     * }
+     * 
+     * </pre>
+     */
     final URI RANK = new URIImpl(SEARCH_NAMESPACE+"rank");
     
+    /**
+     * Magic predicate used to query for free text search metadata.  Use 
+     * in conjunction with {@link #SEARCH} as follows:
+     * <p>
+     * <pre>
+     * 
+     * select ?s ?matched
+     * where {
+     *   ?s bd:search &quot;scale-out RDF triplestore&quot; .
+     *   ?s bd:numMatchedTokens ?matched .
+     * }
+     * 
+     * </pre>
+     */
     final URI NUM_MATCHED_TOKENS = new URIImpl(SEARCH_NAMESPACE+"numMatchedTokens");
 
     /**


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.