[Bigdata-commit] SF.net SVN: bigdata:[7693] branches/BIGDATA_RELEASE_1_3_0/bigdata-rdf/src/ java/com/bigdata/rdf/store/BDS.java

[<tho...@us...>]

Revision: 7693
          http://bigdata.svn.sourceforge.net/bigdata/?rev=7693&view=rev
Author:   thompsonbry
Date:     2013-12-24 13:23:21 +0000 (Tue, 24 Dec 2013)
Log Message:
-----------
updated javadoc for bigdata free text search (BDS interface).

Modified Paths:
--------------
    branches/BIGDATA_RELEASE_1_3_0/bigdata-rdf/src/java/com/bigdata/rdf/store/BDS.java

Modified: branches/BIGDATA_RELEASE_1_3_0/bigdata-rdf/src/java/com/bigdata/rdf/store/BDS.java
===================================================================
--- branches/BIGDATA_RELEASE_1_3_0/bigdata-rdf/src/java/com/bigdata/rdf/store/BDS.java	2013-12-24 00:33:28 UTC (rev 7692)
+++ branches/BIGDATA_RELEASE_1_3_0/bigdata-rdf/src/java/com/bigdata/rdf/store/BDS.java	2013-12-24 13:23:21 UTC (rev 7693)
@@ -28,18 +28,17 @@
 
 package com.bigdata.rdf.store;
 
-import org.openrdf.model.Resource;
 import org.openrdf.model.URI;
-import org.openrdf.model.Value;
 import org.openrdf.model.impl.URIImpl;
-import org.openrdf.model.vocabulary.SESAME;
 
-import com.bigdata.rdf.sparql.ast.cache.DescribeServiceFactory;
 
-
 /**
  * A vocabulary for bigdata specific extensions.
  * 
+ * @see <a
+ *      href="http://sourceforge.net/apps/mediawiki/bigdata/index.php?title=FullTextSearch">
+ *      Free Text Index </a>
+ * 
  * @author <a href="mailto:tho...@us...">Bryan Thompson</a>
  * @version $Id: BD.java 6786 2012-12-19 18:43:27Z thompsonbry $
  */
@@ -86,9 +85,11 @@
     final URI SEARCH = new URIImpl(NAMESPACE+"search");
     
     /**
-     * Magic predicate used to query for free text search metadata.  Use 
-     * in conjunction with {@link #SEARCH} as follows:
+     * Magic predicate used to query for free text search metadata, reporting
+     * the relevance of the search result to the search query. Use in
+     * conjunction with {@link #SEARCH} as follows:
      * <p>
+     * 
      * <pre>
      * 
      * select ?s ?relevance
@@ -98,13 +99,20 @@
      * }
      * 
      * </pre>
+     * 
+     * @see #MIN_RELEVANCE
+     * @see #MAX_RELEVANCE
      */
     final URI RELEVANCE = new URIImpl(NAMESPACE+"relevance");
     
     /**
-     * Magic predicate used to query for free text search metadata.  Use 
-     * in conjunction with {@link #SEARCH} as follows:
+     * Magic predicate used to query for free text search metadata, reporting
+     * the rank (origin ONE (1)) of the search result amoung the search results
+     * obtained for the search query. The rank is from ONE to N, where N is the
+     * number of search results from the full text index. Use in conjunction
+     * with {@link #SEARCH} as follows:
      * <p>
+     * 
      * <pre>
      * 
      * select ?s ?rank
@@ -114,13 +122,18 @@
      * }
      * 
      * </pre>
+     * 
+     * @see #MIN_RANK
+     * @see #MAX_RANK
      */
     final URI RANK = new URIImpl(NAMESPACE+"rank");
     
     /**
-     * Magic predicate used to query for free text search metadata.  Use 
+     * Magic predicate used to limit the maximum rank of the free text search
+     * results to the specified value (default {@value #DEFAULT_MAX_RANK)}. Use
      * in conjunction with {@link #SEARCH} as follows:
      * <p>
+     * 
      * <pre>
      * 
      * select ?s
@@ -131,7 +144,13 @@
      * 
      * </pre>
      * 
-     * The default is {@value #DEFAULT_MAX_RANK}.
+     * You can use {@link #MIN_RANK} and {@link #MAX_RANK} together to page
+     * through the search results. This is often key to achieving low latency
+     * graph search. By limiting the number of results that are fed into the
+     * remained of the SPARQL query, you can ensure that the SPARQL query runs
+     * quickly. If you do not get enough results from the SPARQL query, you can
+     * feed the next "page" of free text results by changing the values for the
+     * {@link #MIN_RANK} AND {@link #MAX_RANK} query hints.
      */
     final URI MAX_RANK = new URIImpl(NAMESPACE+"maxRank");
 
@@ -141,9 +160,11 @@
     final int DEFAULT_MAX_RANK = Integer.MAX_VALUE;
     
     /**
-     * Magic predicate used to query for free text search metadata.  Use 
+     * Magic predicate used to limit the minimum rank of the free text search
+     * results to the specified value (default {@value #DEFAULT_MIN_RANK}). Use
      * in conjunction with {@link #SEARCH} as follows:
      * <p>
+     * 
      * <pre>
      * 
      * select ?s

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