incubator-blur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From amccu...@apache.org
Subject [05/10] More documentation.
Date Sun, 18 Aug 2013 00:15:11 GMT
http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java
index 0e5dae6..56c205e 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java
@@ -31,12 +31,14 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * The error type of a BlurException.<br/><br/>
- * UNKNOWN - Unknown error.<br/><br/>
- * QUERY_CANCEL - Query has been cancel.<br/><br/>
- * QUERY_TIMEOUT - Query has timed out.<br/><br/>
- * BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/>
- * REQUEST_TIMEOUT - The TCP connection has timed out.<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">The error type of a BlurException.</td></tr>
+ * <tr><td>UNKNOWN</td><td>Unknown error.</td></tr>
+ * <tr><td>QUERY_CANCEL</td><td>Query has been cancel.</td></tr>
+ * <tr><td>QUERY_TIMEOUT</td><td>Query has timed out.</td></tr>
+ * <tr><td>BACK_PRESSURE</td><td>Server has run out of memory and
is trying to prevent a failure.</td></tr>
+ * <tr><td>REQUEST_TIMEOUT</td><td>The TCP connection has timed out.</td></tr>
+ * </table>
  */
 public enum ErrorType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   UNKNOWN(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/QueryState.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/QueryState.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/QueryState.java
index 25b02bc..4b9ad48 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/QueryState.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/QueryState.java
@@ -31,10 +31,12 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * The state of a query.<br/><br/>
- * RUNNING - Query is running.<br/><br/>
- * INTERRUPTED - Query has been interrupted.<br/><br/>
- * COMPLETE - Query is complete.<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">The state of a query.</td></tr>
+ * <tr><td>RUNNING</td><td>Query is running.</td></tr>
+ * <tr><td>INTERRUPTED</td><td>Query has been interrupted.</td></tr>
+ * <tr><td>COMPLETE</td><td>Query is complete.</td></tr>
+ * </table>
  */
 public enum QueryState implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   RUNNING(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RecordMutationType.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RecordMutationType.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RecordMutationType.java
index 1ea9d37..c256e6a 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RecordMutationType.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RecordMutationType.java
@@ -31,11 +31,13 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * Specifies the type of Record mutation that should occur during a mutation of a given Record.<br/><br/>
- * DELETE_ENTIRE_RECORD -  Indicates the Record with the given recordId in the given Row
is to be deleted.  If the target record does not exist, then no changes are made.<br/><br/>
- * REPLACE_ENTIRE_RECORD - Indicates the Record with the given recordId in the given Row
is to be deleted, and a new Record with the same id is to be added. If the specified record
does not exist the new record is still added.<br/><br/>
- * REPLACE_COLUMNS - Replace the columns that are specified in the Record mutation.  If the
target record does not exist then this mutation will result in a BlurException.<br/><br/>
- * APPEND_COLUMN_VALUES - Append the columns in the Record mutation to the Record that could
already exist.  If the target record does not exist then this mutation will result in a BlurException.<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">Specifies the type of Record mutation that should occur
during a mutation of a given Record.</td></tr>
+ * <tr><td>DELETE_ENTIRE_RECORD</td><td>Indicates the Record with
the given recordId in the given Row is to be deleted.  If the target record does not exist,
then no changes are made.</td></tr>
+ * <tr><td>REPLACE_ENTIRE_RECORD</td><td>Indicates the Record with
the given recordId in the given Row is to be deleted, and a new Record with the same id is
to be added. If the specified record does not exist the new record is still added.</td></tr>
+ * <tr><td>REPLACE_COLUMNS</td><td>Replace the columns that are specified
in the Record mutation.  If the target record does not exist then this mutation will result
in a BlurException.</td></tr>
+ * <tr><td>APPEND_COLUMN_VALUES</td><td>Append the columns in the
Record mutation to the Record that could already exist.  If the target record does not exist
then this mutation will result in a BlurException.</td></tr>
+ * </table>
  */
 public enum RecordMutationType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   DELETE_ENTIRE_RECORD(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RowMutationType.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RowMutationType.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RowMutationType.java
index 312232a..64ab0f9 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RowMutationType.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/RowMutationType.java
@@ -31,10 +31,12 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * Specifies the type of Row mutation that should occur during a mutation of a given Row.<br/><br/>
- * DELETE_ROW - Indicates that the entire Row is to be deleted.  No changes are made if the
specified row does not exist.<br/><br/>
- * REPLACE_ROW - Indicates that the entire Row is to be deleted, and then a new Row with
the same id is to be added.  If the specified row does not exist, the new row will still be
created.<br/><br/>
- * UPDATE_ROW - Indicates that mutations of the underlying Records will be processed individually.
 Mutation will result in a BlurException if the specified row does not exist.<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">Specifies the type of Row mutation that should occur during
a mutation of a given Row.</td></tr>
+ * <tr><td>DELETE_ROW</td><td>Indicates that the entire Row is to
be deleted.  No changes are made if the specified row does not exist.</td></tr>
+ * <tr><td>REPLACE_ROW</td><td>Indicates that the entire Row is to
be deleted, and then a new Row with the same id is to be added.  If the specified row does
not exist, the new row will still be created.</td></tr>
+ * <tr><td>UPDATE_ROW</td><td>Indicates that mutations of the underlying
Records will be processed individually.  Mutation will result in a BlurException if the specified
row does not exist.</td></tr>
+ * </table>
  */
 public enum RowMutationType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   DELETE_ROW(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ScoreType.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ScoreType.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ScoreType.java
index 11bcc07..7e7cc5e 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ScoreType.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ScoreType.java
@@ -31,11 +31,13 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * The scoring type used during a SuperQuery to score multi Record hits within a ColumnFamily.<br/><br/>
- * SUPER - During a multi Record match, a calculation of the best match Record plus how often
it occurs within the match Row produces the score that is used in the scoring of the SuperQuery.<br/><br/>
- * AGGREGATE - During a multi Record match, the aggregate score of all the Records within
a ColumnFamily is used in the scoring of the SuperQuery.<br/><br/>
- * BEST - During a multi Record match, the best score of all the Records within a ColumnFamily
is used in the scoring of the SuperQuery.<br/><br/>
- * CONSTANT - A constant score of 1 is used in the scoring of the SuperQuery.<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">The scoring type used during a SuperQuery to score multi
Record hits within a ColumnFamily.</td></tr>
+ * <tr><td>SUPER</td><td>During a multi Record match, a calculation
of the best match Record plus how often it occurs within the match Row produces the score
that is used in the scoring of the SuperQuery.</td></tr>
+ * <tr><td>AGGREGATE</td><td>During a multi Record match, the aggregate
score of all the Records within a ColumnFamily is used in the scoring of the SuperQuery.</td></tr>
+ * <tr><td>BEST</td><td>During a multi Record match, the best score
of all the Records within a ColumnFamily is used in the scoring of the SuperQuery.</td></tr>
+ * <tr><td>CONSTANT</td><td>A constant score of 1 is used in the
scoring of the SuperQuery.</td></tr>
+ * </table>
  */
 public enum ScoreType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   SUPER(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ShardState.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ShardState.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ShardState.java
index b562898..2c2d6a3 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ShardState.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ShardState.java
@@ -31,7 +31,15 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * See shardServerLayoutOptions method in the Blur service for details.
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td colspan="2">The shard state, see shardServerLayoutOptions method in
the Blur service for details.</td></tr>
+ * <tr><td>OPENING</td><td>The shard is opening.</td></tr>
+ * <tr><td>OPEN</td><td>The shard is open.</td></tr>
+ * <tr><td>OPENING_ERROR</td><td>An error during the opening of the
shard.</td></tr>
+ * <tr><td>CLOSING</td><td>In the process of closing.</td></tr>
+ * <tr><td>CLOSED</td><td>The shard is closed.</td></tr>
+ * <tr><td>CLOSING_ERROR</td><td>An error during the closing of the
shard.</td></tr>
+ * </table>
  */
 public enum ShardState implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   OPENING(0),

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java
b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java
index 2086772..34a652a 100644
--- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java
+++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java
@@ -31,8 +31,10 @@ import java.util.HashMap;
 import org.apache.blur.thirdparty.thrift_0_9_0.TEnum;
 
 /**
- * NOT_FOUND - when UUID is not found<br/><br/>
- * FOUND - when UUID is present<br/>
+ * <table class="table-bordered table-striped table-condensed">
+ * <tr><td>NOT_FOUND</td><td>Blur status UUID is not found.</td></tr>
+ * <tr><td>FOUND</td><td>Blur status UUID is present.</td></tr>
+ * </table>
  */
 public enum Status implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum {
   NOT_FOUND(0),


Mime
View raw message