Changed the javadoc a little bit.

Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/eb77851a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/eb77851a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/eb77851a

Branch: refs/heads/0.2-dev
Commit: eb77851ae831c3006345c1aa7816b8cba60177d3
Parents: 0b84657
Author: Aaron McCurry <[email protected]>
Authored: Thu Nov 29 21:50:44 2012 -0500
Committer: Aaron McCurry <[email protected]>
Committed: Thu Nov 29 21:50:44 2012 -0500

----------------------------------------------------------------------
 interface/Blur.thrift                              |   24 ++++--
 interface/gen-html/Blur.html                       |   24 ++++---
 .../apache/blur/thrift/generated/AnalyzerType.java |    2 +-
 .../org/apache/blur/thrift/generated/Field.java    |    3 +
 .../blur/thrift/generated/TableDescriptor.java     |   60 +++++++++------
 .../org/apache/blur/thrift/generated/Term.java     |   16 ++--
 interface/gen-rb/blur_types.rb                     |   22 +++--
 .../apache/blur/thrift/generated/AnalyzerType.java |    2 +-
 .../org/apache/blur/thrift/generated/Field.java    |    3 +
 .../blur/thrift/generated/TableDescriptor.java     |   60 +++++++++------
 .../org/apache/blur/thrift/generated/Term.java     |   16 ++--
 11 files changed, 138 insertions(+), 94 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/Blur.thrift
----------------------------------------------------------------------
diff --git a/interface/Blur.thrift b/interface/Blur.thrift
index 6394145..1c76b8c 100644
--- a/interface/Blur.thrift
+++ b/interface/Blur.thrift
@@ -241,7 +241,7 @@ struct AnalyzerSubType {
  * with several different analyzer while only storing the value once.  For 
example, if 
  * field "name" was a TEXT type the class definition could be set to Lowercase 
  * analyzer and the analyzer sub types could be set to Keyword (with a sub 
field name 
- * of "key") and Standard analyzer (with a sub field name of "standard").  
Then in 
+ * of "name.key") and Standard analyzer (with a sub field name of 
"name.standard").  Then in 
  * queries the Lowercase analyzer would be used when "name" is referenced, 
Keyword 
  * analyzer would be referenced when "name.key" is referenced and Standard 
analyzer 
  * would be referenced when "name.standard" is referenced.
@@ -280,32 +280,35 @@ struct Analyzer {
  */
 struct TableDescriptor {
   /**
-   *
+   * The name of the table.
    */
   1:string name,
 
   /**
-   *
+   * Is the table enable for queries and updates.
    */
   2:bool enabled = 1,
 
   /**
-   *
+   * The number of shards in the table.
    */
   3:i32 shardCount = 1,
 
   /**
-   *
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS 
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   4:string storagePath,
 
   /**
-   *
+   * The analyzer definition for this table.  If null the default behavior for 
each 
+   * field will be used.
    */
   5:Analyzer analyzer,
 
   /**
-   *
+   * This will only allow queries to be executed on the table.  The underlying 
implementation 
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   6:bool readOnly = 0,
 
@@ -356,6 +359,9 @@ struct TopFieldDocs {
  5:list<SortField> fields
 }
 
+/**
+ * 
+ */
 struct Field {
  /**
   * The name of the field.
@@ -384,11 +390,11 @@ struct Document {
 
 struct Term {
  /**
-  *
+  * Field name.
   */
  1:string field,
  /**
-  *
+  * Field values.
   */
  2:binary bytes
 }

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-html/Blur.html
----------------------------------------------------------------------
diff --git a/interface/gen-html/Blur.html b/interface/gen-html/Blur.html
index 13aae31..42e1bf9 100644
--- a/interface/gen-html/Blur.html
+++ b/interface/gen-html/Blur.html
@@ -169,7 +169,7 @@ with optional analyzer sub types.  The sub types allow for 
indexing a single fie
 with several different analyzer while only storing the value once.  For 
example, if
 field "name" was a TEXT type the class definition could be set to Lowercase
 analyzer and the analyzer sub types could be set to Keyword (with a sub field 
name
-of "key") and Standard analyzer (with a sub field name of "standard").  Then in
+of "name.key") and Standard analyzer (with a sub field name of 
"name.standard").  Then in
 queries the Lowercase analyzer would be used when "name" is referenced, Keyword
 analyzer would be referenced when "name.key" is referenced and Standard 
analyzer
 would be referenced when "name.standard" is referenced.
@@ -183,17 +183,20 @@ Analyzer struct allows for defining alternate behavior.  
Such as a field with a
 type using a Lowercase Analyzer instead of the default StandardAnalyzer.
 <br/></div><div class="definition"><h3 id="Struct_TableDescriptor">Struct: 
TableDescriptor</h3>
 <table class="table-bordered table-striped 
table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
 value</th></thead>
-<tr><td>1</td><td>name</td><td><code>string</code></td><td>
+<tr><td>1</td><td>name</td><td><code>string</code></td><td>The name of the 
table.
 </td><td>default</td><td></td></tr>
-<tr><td>2</td><td>enabled</td><td><code>bool</code></td><td>
+<tr><td>2</td><td>enabled</td><td><code>bool</code></td><td>Is the table 
enable for queries and updates.
 </td><td>default</td><td>1</td></tr>
-<tr><td>3</td><td>shardCount</td><td><code>i32</code></td><td>
+<tr><td>3</td><td>shardCount</td><td><code>i32</code></td><td>The number of 
shards in the table.
 </td><td>default</td><td>1</td></tr>
-<tr><td>4</td><td>storagePath</td><td><code>string</code></td><td>
+<tr><td>4</td><td>storagePath</td><td><code>string</code></td><td>The storage 
path is a HDFS URI for storing all of the indexes.  Any valid HDFS
+URI can be used such as hdfs://hostname/path, or file:///path, etc.
 </td><td>default</td><td></td></tr>
-<tr><td>5</td><td>analyzer</td><td><code><a 
href="Blur.html#Struct_Analyzer">Analyzer</a></code></td><td>
+<tr><td>5</td><td>analyzer</td><td><code><a 
href="Blur.html#Struct_Analyzer">Analyzer</a></code></td><td>The analyzer 
definition for this table.  If null the default behavior for each
+field will be used.
 </td><td>default</td><td></td></tr>
-<tr><td>6</td><td>readOnly</td><td><code>bool</code></td><td>
+<tr><td>6</td><td>readOnly</td><td><code>bool</code></td><td>This will only 
allow queries to be executed on the table.  The underlying implementation
+does not open the index for writing, but will refresh the index periodically.
 </td><td>default</td><td>0</td></tr>
 <tr><td>7</td><td>properties</td><td><code>map&lt;<code>string</code>, 
<code>string</code>&gt;</code></td><td>compressionClass,compressionBlockSize,similarityClass,blockCaching
 = 1,blockCachingFileTypes,columnPreCache
 </td><td>default</td><td></td></tr>
@@ -243,15 +246,16 @@ type using a Lowercase Analyzer instead of the default 
StandardAnalyzer.
 </td><td>default</td><td></td></tr>
 <tr><td>4</td><td>boost</td><td><code>double</code></td><td>The boost of the 
field.  Default of 1.0 for no change to the boost.
 </td><td>default</td><td>1</td></tr>
-</table><br/></div><div class="definition"><h3 id="Struct_Document">Struct: 
Document</h3>
+</table><br/> 
+<br/></div><div class="definition"><h3 id="Struct_Document">Struct: 
Document</h3>
 <table class="table-bordered table-striped 
table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
 value</th></thead>
 <tr><td>1</td><td>fields</td><td><code>list&lt;<code><a 
href="Blur.html#Struct_Field">Field</a></code>&gt;</code></td><td>This list of 
fields to be indexed.  The same field name can be used across fields and the 
order of the fields will be maintained.
 </td><td>default</td><td></td></tr>
 </table><br/></div><div class="definition"><h3 id="Struct_Term">Struct: 
Term</h3>
 <table class="table-bordered table-striped 
table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
 value</th></thead>
-<tr><td>1</td><td>field</td><td><code>string</code></td><td>
+<tr><td>1</td><td>field</td><td><code>string</code></td><td>Field name.
 </td><td>default</td><td></td></tr>
-<tr><td>2</td><td>bytes</td><td><code>binary</code></td><td>
+<tr><td>2</td><td>bytes</td><td><code>binary</code></td><td>Field values.
 </td><td>default</td><td></td></tr>
 </table><br/></div><div class="definition"><h3 
id="Struct_MutateOptions">Struct: MutateOptions</h3>
 <table class="table-bordered table-striped 
table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
 value</th></thead>

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-java/org/apache/blur/thrift/generated/AnalyzerType.java
----------------------------------------------------------------------
diff --git 
a/interface/gen-java/org/apache/blur/thrift/generated/AnalyzerType.java 
b/interface/gen-java/org/apache/blur/thrift/generated/AnalyzerType.java
index aec8238..ec59f04 100644
--- a/interface/gen-java/org/apache/blur/thrift/generated/AnalyzerType.java
+++ b/interface/gen-java/org/apache/blur/thrift/generated/AnalyzerType.java
@@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory;
  * with several different analyzer while only storing the value once.  For 
example, if
  * field "name" was a TEXT type the class definition could be set to Lowercase
  * analyzer and the analyzer sub types could be set to Keyword (with a sub 
field name
- * of "key") and Standard analyzer (with a sub field name of "standard").  
Then in
+ * of "name.key") and Standard analyzer (with a sub field name of 
"name.standard").  Then in
  * queries the Lowercase analyzer would be used when "name" is referenced, 
Keyword
  * analyzer would be referenced when "name.key" is referenced and Standard 
analyzer
  * would be referenced when "name.standard" is referenced.

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-java/org/apache/blur/thrift/generated/Field.java
----------------------------------------------------------------------
diff --git a/interface/gen-java/org/apache/blur/thrift/generated/Field.java 
b/interface/gen-java/org/apache/blur/thrift/generated/Field.java
index 07dd352..921f49e 100644
--- a/interface/gen-java/org/apache/blur/thrift/generated/Field.java
+++ b/interface/gen-java/org/apache/blur/thrift/generated/Field.java
@@ -49,6 +49,9 @@ import java.util.Arrays;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ *  
+ */
 public class Field implements org.apache.thrift.TBase<Field, Field._Fields>, 
java.io.Serializable, Cloneable {
   private static final org.apache.thrift.protocol.TStruct STRUCT_DESC = new 
org.apache.thrift.protocol.TStruct("Field");
 

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-java/org/apache/blur/thrift/generated/TableDescriptor.java
----------------------------------------------------------------------
diff --git 
a/interface/gen-java/org/apache/blur/thrift/generated/TableDescriptor.java 
b/interface/gen-java/org/apache/blur/thrift/generated/TableDescriptor.java
index d205bbf..0202abf 100644
--- a/interface/gen-java/org/apache/blur/thrift/generated/TableDescriptor.java
+++ b/interface/gen-java/org/apache/blur/thrift/generated/TableDescriptor.java
@@ -70,27 +70,30 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public String name; // required
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public boolean enabled; // required
   /**
-   * 
+   * The number of shards in the table.
    */
   public int shardCount; // required
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public String storagePath; // required
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public Analyzer analyzer; // required
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public boolean readOnly; // required
   /**
@@ -101,27 +104,30 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   /** The set of fields this struct contains, along with convenience methods 
for finding and manipulating them. */
   public enum _Fields implements org.apache.thrift.TFieldIdEnum {
     /**
-     * 
+     * The name of the table.
      */
     NAME((short)1, "name"),
     /**
-     * 
+     * Is the table enable for queries and updates.
      */
     ENABLED((short)2, "enabled"),
     /**
-     * 
+     * The number of shards in the table.
      */
     SHARD_COUNT((short)3, "shardCount"),
     /**
-     * 
+     * The storage path is a HDFS URI for storing all of the indexes.  Any 
valid HDFS
+     * URI can be used such as hdfs://hostname/path, or file:///path, etc.
      */
     STORAGE_PATH((short)4, "storagePath"),
     /**
-     * 
+     * The analyzer definition for this table.  If null the default behavior 
for each
+     * field will be used.
      */
     ANALYZER((short)5, "analyzer"),
     /**
-     * 
+     * This will only allow queries to be executed on the table.  The 
underlying implementation
+     * does not open the index for writing, but will refresh the index 
periodically.
      */
     READ_ONLY((short)6, "readOnly"),
     /**
@@ -307,14 +313,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public String getName() {
     return this.name;
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public TableDescriptor setName(String name) {
     this.name = name;
@@ -337,14 +343,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public boolean isEnabled() {
     return this.enabled;
   }
 
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public TableDescriptor setEnabled(boolean enabled) {
     this.enabled = enabled;
@@ -366,14 +372,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The number of shards in the table.
    */
   public int getShardCount() {
     return this.shardCount;
   }
 
   /**
-   * 
+   * The number of shards in the table.
    */
   public TableDescriptor setShardCount(int shardCount) {
     this.shardCount = shardCount;
@@ -395,14 +401,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public String getStoragePath() {
     return this.storagePath;
   }
 
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public TableDescriptor setStoragePath(String storagePath) {
     this.storagePath = storagePath;
@@ -425,14 +433,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public Analyzer getAnalyzer() {
     return this.analyzer;
   }
 
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public TableDescriptor setAnalyzer(Analyzer analyzer) {
     this.analyzer = analyzer;
@@ -455,14 +465,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public boolean isReadOnly() {
     return this.readOnly;
   }
 
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public TableDescriptor setReadOnly(boolean readOnly) {
     this.readOnly = readOnly;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-java/org/apache/blur/thrift/generated/Term.java
----------------------------------------------------------------------
diff --git a/interface/gen-java/org/apache/blur/thrift/generated/Term.java 
b/interface/gen-java/org/apache/blur/thrift/generated/Term.java
index ee66f99..357a107 100644
--- a/interface/gen-java/org/apache/blur/thrift/generated/Term.java
+++ b/interface/gen-java/org/apache/blur/thrift/generated/Term.java
@@ -62,22 +62,22 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field name.
    */
   public String field; // required
   /**
-   * 
+   * Field values.
    */
   public ByteBuffer bytes; // required
 
   /** The set of fields this struct contains, along with convenience methods 
for finding and manipulating them. */
   public enum _Fields implements org.apache.thrift.TFieldIdEnum {
     /**
-     * 
+     * Field name.
      */
     FIELD((short)1, "field"),
     /**
-     * 
+     * Field values.
      */
     BYTES((short)2, "bytes");
 
@@ -185,14 +185,14 @@ public class Term implements 
org.apache.thrift.TBase<Term, Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field name.
    */
   public String getField() {
     return this.field;
   }
 
   /**
-   * 
+   * Field name.
    */
   public Term setField(String field) {
     this.field = field;
@@ -215,7 +215,7 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field values.
    */
   public byte[] getBytes() {
     setBytes(org.apache.thrift.TBaseHelper.rightSize(bytes));
@@ -227,7 +227,7 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field values.
    */
   public Term setBytes(byte[] bytes) {
     setBytes(bytes == null ? (ByteBuffer)null : ByteBuffer.wrap(bytes));

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/interface/gen-rb/blur_types.rb
----------------------------------------------------------------------
diff --git a/interface/gen-rb/blur_types.rb b/interface/gen-rb/blur_types.rb
index a7359b6..d22b325 100644
--- a/interface/gen-rb/blur_types.rb
+++ b/interface/gen-rb/blur_types.rb
@@ -226,7 +226,7 @@ module Blur
 # with several different analyzer while only storing the value once.  For 
example, if
 # field "name" was a TEXT type the class definition could be set to Lowercase
 # analyzer and the analyzer sub types could be set to Keyword (with a sub 
field name
-# of "key") and Standard analyzer (with a sub field name of "standard").  Then 
in
+# of "name.key") and Standard analyzer (with a sub field name of 
"name.standard").  Then in
 # queries the Lowercase analyzer would be used when "name" is referenced, 
Keyword
 # analyzer would be referenced when "name.key" is referenced and Standard 
analyzer
 # would be referenced when "name.standard" is referenced.
@@ -287,17 +287,20 @@ module Blur
     PROPERTIES = 7
 
     FIELDS = {
-      # 
+      # The name of the table.
       NAME => {:type => ::Thrift::Types::STRING, :name => 'name'},
-      # 
+      # Is the table enable for queries and updates.
       ENABLED => {:type => ::Thrift::Types::BOOL, :name => 'enabled', :default 
=> true},
-      # 
+      # The number of shards in the table.
       SHARDCOUNT => {:type => ::Thrift::Types::I32, :name => 'shardCount', 
:default => 1},
-      # 
+      # The storage path is a HDFS URI for storing all of the indexes.  Any 
valid HDFS
+# URI can be used such as hdfs://hostname/path, or file:///path, etc.
       STORAGEPATH => {:type => ::Thrift::Types::STRING, :name => 
'storagePath'},
-      # 
+      # The analyzer definition for this table.  If null the default behavior 
for each
+# field will be used.
       ANALYZER => {:type => ::Thrift::Types::STRUCT, :name => 'analyzer', 
:class => ::Blur::Analyzer},
-      # 
+      # This will only allow queries to be executed on the table.  The 
underlying implementation
+# does not open the index for writing, but will refresh the index periodically.
       READONLY => {:type => ::Thrift::Types::BOOL, :name => 'readOnly', 
:default => false},
       # compressionClass,compressionBlockSize,similarityClass,blockCaching = 
1,blockCachingFileTypes,columnPreCache
       PROPERTIES => {:type => ::Thrift::Types::MAP, :name => 'properties', 
:key => {:type => ::Thrift::Types::STRING}, :value => {:type => 
::Thrift::Types::STRING}}
@@ -444,6 +447,7 @@ module Blur
     ::Thrift::Struct.generate_accessors self
   end
 
+  #  
   class Field
     include ::Thrift::Struct, ::Thrift::Struct_Union
     NAME = 1
@@ -496,9 +500,9 @@ module Blur
     BYTES = 2
 
     FIELDS = {
-      # 
+      # Field name.
       FIELD => {:type => ::Thrift::Types::STRING, :name => 'field'},
-      # 
+      # Field values.
       BYTES => {:type => ::Thrift::Types::STRING, :name => 'bytes', :binary => 
true}
     }
 

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/AnalyzerType.java
----------------------------------------------------------------------
diff --git 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/AnalyzerType.java
 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/AnalyzerType.java
index aec8238..ec59f04 100644
--- 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/AnalyzerType.java
+++ 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/AnalyzerType.java
@@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory;
  * with several different analyzer while only storing the value once.  For 
example, if
  * field "name" was a TEXT type the class definition could be set to Lowercase
  * analyzer and the analyzer sub types could be set to Keyword (with a sub 
field name
- * of "key") and Standard analyzer (with a sub field name of "standard").  
Then in
+ * of "name.key") and Standard analyzer (with a sub field name of 
"name.standard").  Then in
  * queries the Lowercase analyzer would be used when "name" is referenced, 
Keyword
  * analyzer would be referenced when "name.key" is referenced and Standard 
analyzer
  * would be referenced when "name.standard" is referenced.

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Field.java
----------------------------------------------------------------------
diff --git 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Field.java 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Field.java
index 07dd352..921f49e 100644
--- a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Field.java
+++ b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Field.java
@@ -49,6 +49,9 @@ import java.util.Arrays;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ *  
+ */
 public class Field implements org.apache.thrift.TBase<Field, Field._Fields>, 
java.io.Serializable, Cloneable {
   private static final org.apache.thrift.protocol.TStruct STRUCT_DESC = new 
org.apache.thrift.protocol.TStruct("Field");
 

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/TableDescriptor.java
----------------------------------------------------------------------
diff --git 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/TableDescriptor.java
 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/TableDescriptor.java
index d205bbf..0202abf 100644
--- 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/TableDescriptor.java
+++ 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/TableDescriptor.java
@@ -70,27 +70,30 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public String name; // required
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public boolean enabled; // required
   /**
-   * 
+   * The number of shards in the table.
    */
   public int shardCount; // required
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public String storagePath; // required
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public Analyzer analyzer; // required
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public boolean readOnly; // required
   /**
@@ -101,27 +104,30 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   /** The set of fields this struct contains, along with convenience methods 
for finding and manipulating them. */
   public enum _Fields implements org.apache.thrift.TFieldIdEnum {
     /**
-     * 
+     * The name of the table.
      */
     NAME((short)1, "name"),
     /**
-     * 
+     * Is the table enable for queries and updates.
      */
     ENABLED((short)2, "enabled"),
     /**
-     * 
+     * The number of shards in the table.
      */
     SHARD_COUNT((short)3, "shardCount"),
     /**
-     * 
+     * The storage path is a HDFS URI for storing all of the indexes.  Any 
valid HDFS
+     * URI can be used such as hdfs://hostname/path, or file:///path, etc.
      */
     STORAGE_PATH((short)4, "storagePath"),
     /**
-     * 
+     * The analyzer definition for this table.  If null the default behavior 
for each
+     * field will be used.
      */
     ANALYZER((short)5, "analyzer"),
     /**
-     * 
+     * This will only allow queries to be executed on the table.  The 
underlying implementation
+     * does not open the index for writing, but will refresh the index 
periodically.
      */
     READ_ONLY((short)6, "readOnly"),
     /**
@@ -307,14 +313,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public String getName() {
     return this.name;
   }
 
   /**
-   * 
+   * The name of the table.
    */
   public TableDescriptor setName(String name) {
     this.name = name;
@@ -337,14 +343,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public boolean isEnabled() {
     return this.enabled;
   }
 
   /**
-   * 
+   * Is the table enable for queries and updates.
    */
   public TableDescriptor setEnabled(boolean enabled) {
     this.enabled = enabled;
@@ -366,14 +372,14 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The number of shards in the table.
    */
   public int getShardCount() {
     return this.shardCount;
   }
 
   /**
-   * 
+   * The number of shards in the table.
    */
   public TableDescriptor setShardCount(int shardCount) {
     this.shardCount = shardCount;
@@ -395,14 +401,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public String getStoragePath() {
     return this.storagePath;
   }
 
   /**
-   * 
+   * The storage path is a HDFS URI for storing all of the indexes.  Any valid 
HDFS
+   * URI can be used such as hdfs://hostname/path, or file:///path, etc.
    */
   public TableDescriptor setStoragePath(String storagePath) {
     this.storagePath = storagePath;
@@ -425,14 +433,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public Analyzer getAnalyzer() {
     return this.analyzer;
   }
 
   /**
-   * 
+   * The analyzer definition for this table.  If null the default behavior for 
each
+   * field will be used.
    */
   public TableDescriptor setAnalyzer(Analyzer analyzer) {
     this.analyzer = analyzer;
@@ -455,14 +465,16 @@ public class TableDescriptor implements 
org.apache.thrift.TBase<TableDescriptor,
   }
 
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public boolean isReadOnly() {
     return this.readOnly;
   }
 
   /**
-   * 
+   * This will only allow queries to be executed on the table.  The underlying 
implementation
+   * does not open the index for writing, but will refresh the index 
periodically.
    */
   public TableDescriptor setReadOnly(boolean readOnly) {
     this.readOnly = readOnly;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/eb77851a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Term.java
----------------------------------------------------------------------
diff --git 
a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Term.java 
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Term.java
index ee66f99..357a107 100644
--- a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Term.java
+++ b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Term.java
@@ -62,22 +62,22 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field name.
    */
   public String field; // required
   /**
-   * 
+   * Field values.
    */
   public ByteBuffer bytes; // required
 
   /** The set of fields this struct contains, along with convenience methods 
for finding and manipulating them. */
   public enum _Fields implements org.apache.thrift.TFieldIdEnum {
     /**
-     * 
+     * Field name.
      */
     FIELD((short)1, "field"),
     /**
-     * 
+     * Field values.
      */
     BYTES((short)2, "bytes");
 
@@ -185,14 +185,14 @@ public class Term implements 
org.apache.thrift.TBase<Term, Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field name.
    */
   public String getField() {
     return this.field;
   }
 
   /**
-   * 
+   * Field name.
    */
   public Term setField(String field) {
     this.field = field;
@@ -215,7 +215,7 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field values.
    */
   public byte[] getBytes() {
     setBytes(org.apache.thrift.TBaseHelper.rightSize(bytes));
@@ -227,7 +227,7 @@ public class Term implements org.apache.thrift.TBase<Term, 
Term._Fields>, java.i
   }
 
   /**
-   * 
+   * Field values.
    */
   public Term setBytes(byte[] bytes) {
     setBytes(bytes == null ? (ByteBuffer)null : ByteBuffer.wrap(bytes));

Reply via email to