You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by ee...@apache.org on 2009/12/08 23:59:53 UTC
svn commit: r888619 -
/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/
Author: eevans
Date: Tue Dec 8 22:59:52 2009
New Revision: 888619
URL: http://svn.apache.org/viewvc?rev=888619&view=rev
Log:
regenerate thrift code to realize new docstrings
Modified:
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Cassandra.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Column.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnOrSuperColumn.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnParent.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnPath.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/InvalidRequestException.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/KeySlice.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/NotFoundException.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SlicePredicate.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SliceRange.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SuperColumn.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/TimedOutException.java
incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/UnavailableException.java
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Cassandra.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Cassandra.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Cassandra.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Cassandra.java Tue Dec 8 22:59:52 2009
@@ -46,14 +46,60 @@
public interface Iface {
+ /**
+ * Get the Column or SuperColumn at the given column_path. If no value is present, NotFoundException is thrown. (This is
+ * the only method that can throw an exception under non-failure conditions.)
+ *
+ * @param keyspace
+ * @param key
+ * @param column_path
+ * @param consistency_level
+ */
public ColumnOrSuperColumn get(String keyspace, String key, ColumnPath column_path, int consistency_level) throws InvalidRequestException, NotFoundException, UnavailableException, TimedOutException, TException;
+ /**
+ * Get the group of columns contained by column_parent (either a ColumnFamily name or a ColumnFamily/SuperColumn name
+ * pair) specified by the given SlicePredicate. If no matching values are found, an empty list is returned.
+ *
+ * @param keyspace
+ * @param key
+ * @param column_parent
+ * @param predicate
+ * @param consistency_level
+ */
public List<ColumnOrSuperColumn> get_slice(String keyspace, String key, ColumnParent column_parent, SlicePredicate predicate, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * Perform a get for column_path in parallel on the given list<string> keys. The return value maps keys to the
+ * ColumnOrSuperColumn found. If no value corresponding to a key is present, the key will still be in the map, but both
+ * the column and super_column references of the ColumnOrSuperColumn object it maps to will be null.
+ *
+ * @param keyspace
+ * @param keys
+ * @param column_path
+ * @param consistency_level
+ */
public Map<String,ColumnOrSuperColumn> multiget(String keyspace, List<String> keys, ColumnPath column_path, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * Performs a get_slice for column_parent and predicate for the given keys in parallel.
+ *
+ * @param keyspace
+ * @param keys
+ * @param column_parent
+ * @param predicate
+ * @param consistency_level
+ */
public Map<String,List<ColumnOrSuperColumn>> multiget_slice(String keyspace, List<String> keys, ColumnParent column_parent, SlicePredicate predicate, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * returns the number of columns for a particular <code>key</code> and <code>ColumnFamily</code> or <code>SuperColumn</code>.
+ *
+ * @param keyspace
+ * @param key
+ * @param column_parent
+ * @param consistency_level
+ */
public int get_count(String keyspace, String key, ColumnParent column_parent, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
/**
@@ -68,18 +114,77 @@
*/
public List<String> get_key_range(String keyspace, String column_family, String start, String finish, int count, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * returns a subset of columns for a range of keys.
+ *
+ * @param keyspace
+ * @param column_parent
+ * @param predicate
+ * @param start_key
+ * @param finish_key
+ * @param row_count
+ * @param consistency_level
+ */
public List<KeySlice> get_range_slice(String keyspace, ColumnParent column_parent, SlicePredicate predicate, String start_key, String finish_key, int row_count, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * Insert a Column consisting of (column_path.column, value, timestamp) at the given column_path.column_family and optional
+ * column_path.super_column. Note that column_path.column is here required, since a SuperColumn cannot directly contain binary
+ * values -- it can only contain sub-Columns.
+ *
+ * @param keyspace
+ * @param key
+ * @param column_path
+ * @param value
+ * @param timestamp
+ * @param consistency_level
+ */
public void insert(String keyspace, String key, ColumnPath column_path, byte[] value, long timestamp, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * Insert Columns or SuperColumns across different Column Families for the same row key. batch_mutation is a
+ * map<string, list<ColumnOrSuperColumn>> -- a map which pairs column family names with the relevant ColumnOrSuperColumn
+ * objects to insert.
+ *
+ * @param keyspace
+ * @param key
+ * @param cfmap
+ * @param consistency_level
+ */
public void batch_insert(String keyspace, String key, Map<String,List<ColumnOrSuperColumn>> cfmap, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * Remove data from the row specified by key at the granularity specified by column_path, and the given timestamp. Note
+ * that all the values in column_path besides column_path.column_family are truly optional: you can remove the entire
+ * row by just specifying the ColumnFamily, or you can remove a SuperColumn or a single Column by specifying those levels too.
+ *
+ * @param keyspace
+ * @param key
+ * @param column_path
+ * @param timestamp
+ * @param consistency_level
+ */
public void remove(String keyspace, String key, ColumnPath column_path, long timestamp, int consistency_level) throws InvalidRequestException, UnavailableException, TimedOutException, TException;
+ /**
+ * get property whose value is of type string.
+ *
+ * @param property
+ */
public String get_string_property(String property) throws TException;
+ /**
+ * get property whose value is list of strings.
+ *
+ * @param property
+ */
public List<String> get_string_list_property(String property) throws TException;
+ /**
+ * describe specified keyspace
+ *
+ * @param keyspace
+ */
public Map<String,Map<String,String>> describe_keyspace(String keyspace) throws NotFoundException, TException;
}
@@ -2842,6 +2947,21 @@
return new get_slice_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public java.util.Iterator<ColumnOrSuperColumn> getSuccessIterator() {
+ return (this.success == null) ? null : this.success.iterator();
+ }
+
+ public void addToSuccess(ColumnOrSuperColumn elem) {
+ if (this.success == null) {
+ this.success = new ArrayList<ColumnOrSuperColumn>();
+ }
+ this.success.add(elem);
+ }
+
public List<ColumnOrSuperColumn> getSuccess() {
return this.success;
}
@@ -3370,6 +3490,21 @@
}
}
+ public int getKeysSize() {
+ return (this.keys == null) ? 0 : this.keys.size();
+ }
+
+ public java.util.Iterator<String> getKeysIterator() {
+ return (this.keys == null) ? null : this.keys.iterator();
+ }
+
+ public void addToKeys(String elem) {
+ if (this.keys == null) {
+ this.keys = new ArrayList<String>();
+ }
+ this.keys.add(elem);
+ }
+
public List<String> getKeys() {
return this.keys;
}
@@ -3877,6 +4012,17 @@
return new multiget_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public void putToSuccess(String key, ColumnOrSuperColumn val) {
+ if (this.success == null) {
+ this.success = new HashMap<String,ColumnOrSuperColumn>();
+ }
+ this.success.put(key, val);
+ }
+
public Map<String,ColumnOrSuperColumn> getSuccess() {
return this.success;
}
@@ -4375,6 +4521,21 @@
}
}
+ public int getKeysSize() {
+ return (this.keys == null) ? 0 : this.keys.size();
+ }
+
+ public java.util.Iterator<String> getKeysIterator() {
+ return (this.keys == null) ? null : this.keys.iterator();
+ }
+
+ public void addToKeys(String elem) {
+ if (this.keys == null) {
+ this.keys = new ArrayList<String>();
+ }
+ this.keys.add(elem);
+ }
+
public List<String> getKeys() {
return this.keys;
}
@@ -4964,6 +5125,17 @@
return new multiget_slice_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public void putToSuccess(String key, List<ColumnOrSuperColumn> val) {
+ if (this.success == null) {
+ this.success = new HashMap<String,List<ColumnOrSuperColumn>>();
+ }
+ this.success.put(key, val);
+ }
+
public Map<String,List<ColumnOrSuperColumn>> getSuccess() {
return this.success;
}
@@ -7099,6 +7271,21 @@
return new get_key_range_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public java.util.Iterator<String> getSuccessIterator() {
+ return (this.success == null) ? null : this.success.iterator();
+ }
+
+ public void addToSuccess(String elem) {
+ if (this.success == null) {
+ this.success = new ArrayList<String>();
+ }
+ this.success.add(elem);
+ }
+
public List<String> getSuccess() {
return this.success;
}
@@ -8365,6 +8552,21 @@
return new get_range_slice_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public java.util.Iterator<KeySlice> getSuccessIterator() {
+ return (this.success == null) ? null : this.success.iterator();
+ }
+
+ public void addToSuccess(KeySlice elem) {
+ if (this.success == null) {
+ this.success = new ArrayList<KeySlice>();
+ }
+ this.success.add(elem);
+ }
+
public List<KeySlice> getSuccess() {
return this.success;
}
@@ -10003,6 +10205,17 @@
}
}
+ public int getCfmapSize() {
+ return (this.cfmap == null) ? 0 : this.cfmap.size();
+ }
+
+ public void putToCfmap(String key, List<ColumnOrSuperColumn> val) {
+ if (this.cfmap == null) {
+ this.cfmap = new HashMap<String,List<ColumnOrSuperColumn>>();
+ }
+ this.cfmap.put(key, val);
+ }
+
public Map<String,List<ColumnOrSuperColumn>> getCfmap() {
return this.cfmap;
}
@@ -12457,6 +12670,21 @@
return new get_string_list_property_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public java.util.Iterator<String> getSuccessIterator() {
+ return (this.success == null) ? null : this.success.iterator();
+ }
+
+ public void addToSuccess(String elem) {
+ if (this.success == null) {
+ this.success = new ArrayList<String>();
+ }
+ this.success.add(elem);
+ }
+
public List<String> getSuccess() {
return this.success;
}
@@ -12955,6 +13183,17 @@
return new describe_keyspace_result(this);
}
+ public int getSuccessSize() {
+ return (this.success == null) ? 0 : this.success.size();
+ }
+
+ public void putToSuccess(String key, Map<String,String> val) {
+ if (this.success == null) {
+ this.success = new HashMap<String,Map<String,String>>();
+ }
+ this.success.put(key, val);
+ }
+
public Map<String,Map<String,String>> getSuccess() {
return this.success;
}
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Column.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Column.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Column.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/Column.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,13 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * Basic unit of data within a ColumnFamily.
+ * @param name. A column name can act both as structure (a label) or as data (like value). Regardless, the name of the column
+ * is used as a key to its value.
+ * @param value. Some data
+ * @param timestamp. Used to record when data was sent to be written.
+ */
public class Column implements TBase, java.io.Serializable, Cloneable, Comparable<Column> {
private static final TStruct STRUCT_DESC = new TStruct("Column");
private static final TField NAME_FIELD_DESC = new TField("name", TType.STRING, (short)1);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnOrSuperColumn.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnOrSuperColumn.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnOrSuperColumn.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnOrSuperColumn.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,16 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * Methods for fetching rows/records from Cassandra will return either a single instance of ColumnOrSuperColumn or a list
+ * of ColumnOrSuperColumns (get_slice()). If you're looking up a SuperColumn (or list of SuperColumns) then the resulting
+ * instances of ColumnOrSuperColumn will have the requested SuperColumn in the attribute super_column. For queries resulting
+ * in Columns, those values will be in the attribute column. This change was made between 0.3 and 0.4 to standardize on
+ * single query methods that may return either a SuperColumn or Column.
+ *
+ * @param column. The Column returned by get() or get_slice().
+ * @param super_column. The SuperColumn returned by get() or get_slice().
+ */
public class ColumnOrSuperColumn implements TBase, java.io.Serializable, Cloneable, Comparable<ColumnOrSuperColumn> {
private static final TStruct STRUCT_DESC = new TStruct("ColumnOrSuperColumn");
private static final TField COLUMN_FIELD_DESC = new TField("column", TType.STRUCT, (short)1);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnParent.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnParent.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnParent.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnParent.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,12 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * ColumnParent is used when selecting groups of columns from the same ColumnFamily. In directory structure terms, imagine
+ * ColumnParent as ColumnPath + '/../'.
+ *
+ * See also <a href="cassandra.html#Struct_ColumnPath">ColumnPath</a>
+ */
public class ColumnParent implements TBase, java.io.Serializable, Cloneable, Comparable<ColumnParent> {
private static final TStruct STRUCT_DESC = new TStruct("ColumnParent");
private static final TField COLUMN_FAMILY_FIELD_DESC = new TField("column_family", TType.STRING, (short)3);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnPath.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnPath.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnPath.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/ColumnPath.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,16 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * The ColumnPath is the path to a single column in Cassandra. It might make sense to think of ColumnPath and
+ * ColumnParent in terms of a directory structure.
+ *
+ * ColumnPath is used to looking up a single column.
+ *
+ * @param column_family. The name of the CF of the column being looked up.
+ * @param super_column. The super column name.
+ * @param column. The column name.
+ */
public class ColumnPath implements TBase, java.io.Serializable, Cloneable, Comparable<ColumnPath> {
private static final TStruct STRUCT_DESC = new TStruct("ColumnPath");
private static final TField COLUMN_FAMILY_FIELD_DESC = new TField("column_family", TType.STRING, (short)3);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/InvalidRequestException.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/InvalidRequestException.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/InvalidRequestException.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/InvalidRequestException.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,10 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
+ * why contains an associated error message.
+ */
public class InvalidRequestException extends Exception implements TBase, java.io.Serializable, Cloneable, Comparable<InvalidRequestException> {
private static final TStruct STRUCT_DESC = new TStruct("InvalidRequestException");
private static final TField WHY_FIELD_DESC = new TField("why", TType.STRING, (short)1);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/KeySlice.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/KeySlice.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/KeySlice.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/KeySlice.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,13 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * A KeySlice is key followed by the data it maps to. A collection of KeySlice is returned by the get_range_slice operation.
+ *
+ * @param key. a row key
+ * @param columns. List of data represented by the key. Typically, the list is pared down to only the columns specified by
+ * a SlicePredicate.
+ */
public class KeySlice implements TBase, java.io.Serializable, Cloneable, Comparable<KeySlice> {
private static final TStruct STRUCT_DESC = new TStruct("KeySlice");
private static final TField KEY_FIELD_DESC = new TField("key", TType.STRING, (short)1);
@@ -127,6 +134,21 @@
}
}
+ public int getColumnsSize() {
+ return (this.columns == null) ? 0 : this.columns.size();
+ }
+
+ public java.util.Iterator<ColumnOrSuperColumn> getColumnsIterator() {
+ return (this.columns == null) ? null : this.columns.iterator();
+ }
+
+ public void addToColumns(ColumnOrSuperColumn elem) {
+ if (this.columns == null) {
+ this.columns = new ArrayList<ColumnOrSuperColumn>();
+ }
+ this.columns.add(elem);
+ }
+
public List<ColumnOrSuperColumn> getColumns() {
return this.columns;
}
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/NotFoundException.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/NotFoundException.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/NotFoundException.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/NotFoundException.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,9 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * A specific column was requested that does not exist.
+ */
public class NotFoundException extends Exception implements TBase, java.io.Serializable, Cloneable, Comparable<NotFoundException> {
private static final TStruct STRUCT_DESC = new TStruct("NotFoundException");
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SlicePredicate.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SlicePredicate.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SlicePredicate.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SlicePredicate.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,18 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * A SlicePredicate is similar to a mathematic predicate (see http://en.wikipedia.org/wiki/Predicate_(mathematical_logic)),
+ * which is described as "a property that the elements of a set have in common."
+ *
+ * SlicePredicate's in Cassandra are described with either a list of column_names or a SliceRange. If column_names is
+ * specified, slice_range is ignored.
+ *
+ * @param column_name. A list of column names to retrieve. This can be used similar to Memcached's "multi-get" feature
+ * to fetch N known column names. For instance, if you know you wish to fetch columns 'Joe', 'Jack',
+ * and 'Jim' you can pass those column names as a list to fetch all three at once.
+ * @param slice_range. A SliceRange describing how to range, order, and/or limit the slice.
+ */
public class SlicePredicate implements TBase, java.io.Serializable, Cloneable, Comparable<SlicePredicate> {
private static final TStruct STRUCT_DESC = new TStruct("SlicePredicate");
private static final TField COLUMN_NAMES_FIELD_DESC = new TField("column_names", TType.LIST, (short)1);
@@ -105,6 +117,21 @@
return new SlicePredicate(this);
}
+ public int getColumn_namesSize() {
+ return (this.column_names == null) ? 0 : this.column_names.size();
+ }
+
+ public java.util.Iterator<byte[]> getColumn_namesIterator() {
+ return (this.column_names == null) ? null : this.column_names.iterator();
+ }
+
+ public void addToColumn_names(byte[] elem) {
+ if (this.column_names == null) {
+ this.column_names = new ArrayList<byte[]>();
+ }
+ this.column_names.add(elem);
+ }
+
public List<byte[]> getColumn_names() {
return this.column_names;
}
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SliceRange.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SliceRange.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SliceRange.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SliceRange.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,22 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * A slice range is a structure that stores basic range, ordering and limit information for a query that will return
+ * multiple columns. It could be thought of as Cassandra's version of LIMIT and ORDER BY
+ *
+ * @param start. The column name to start the slice with. This attribute is not required, though there is no default value,
+ * and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it
+ * must a valid value under the rules of the Comparator defined for the given ColumnFamily.
+ * @param finish. The column name to stop the slice at. This attribute is not required, though there is no default value,
+ * and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it
+ * must also be a value value to the ColumnFamily Comparator.
+ * @param reversed. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.
+ * @param count. How many keys to return. Similar to LIMIT 100 in SQL. May be arbitrarily large, but Thrift will
+ * materialize the whole result into memory before returning it to the client, so be aware that you may
+ * be better served by iterating through slices by passing the last value of one call in as the 'start'
+ * of the next instead of increasing 'count' arbitrarily large.
+ */
public class SliceRange implements TBase, java.io.Serializable, Cloneable, Comparable<SliceRange> {
private static final TStruct STRUCT_DESC = new TStruct("SliceRange");
private static final TField START_FIELD_DESC = new TField("start", TType.STRING, (short)1);
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SuperColumn.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SuperColumn.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SuperColumn.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/SuperColumn.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,12 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * A named list of columns.
+ * @param name. see Column.name.
+ * @param columns. A collection of standard Columns. The columns within a super column are defined in an adhoc manner.
+ * Columns within a super column do not have to have matching structures (similarly named child columns).
+ */
public class SuperColumn implements TBase, java.io.Serializable, Cloneable, Comparable<SuperColumn> {
private static final TStruct STRUCT_DESC = new TStruct("SuperColumn");
private static final TField NAME_FIELD_DESC = new TField("name", TType.STRING, (short)1);
@@ -128,6 +134,21 @@
}
}
+ public int getColumnsSize() {
+ return (this.columns == null) ? 0 : this.columns.size();
+ }
+
+ public java.util.Iterator<Column> getColumnsIterator() {
+ return (this.columns == null) ? null : this.columns.iterator();
+ }
+
+ public void addToColumns(Column elem) {
+ if (this.columns == null) {
+ this.columns = new ArrayList<Column>();
+ }
+ this.columns.add(elem);
+ }
+
public List<Column> getColumns() {
return this.columns;
}
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/TimedOutException.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/TimedOutException.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/TimedOutException.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/TimedOutException.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,9 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * RPC timeout was exceeded. either a node failed mid-operation, or load was too high, or the requested op was too large.
+ */
public class TimedOutException extends Exception implements TBase, java.io.Serializable, Cloneable, Comparable<TimedOutException> {
private static final TStruct STRUCT_DESC = new TStruct("TimedOutException");
Modified: incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/UnavailableException.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/UnavailableException.java?rev=888619&r1=888618&r2=888619&view=diff
==============================================================================
--- incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/UnavailableException.java (original)
+++ incubator/cassandra/trunk/interface/gen-java/org/apache/cassandra/service/UnavailableException.java Tue Dec 8 22:59:52 2009
@@ -42,6 +42,9 @@
import org.apache.thrift.meta_data.*;
import org.apache.thrift.protocol.*;
+/**
+ * Not all the replicas required could be created and/or read.
+ */
public class UnavailableException extends Exception implements TBase, java.io.Serializable, Cloneable, Comparable<UnavailableException> {
private static final TStruct STRUCT_DESC = new TStruct("UnavailableException");