Package com.couchbase.lite
Class Result
java.lang.Object
com.couchbase.lite.Result
- All Implemented Interfaces:
ArrayInterface
,DictionaryInterface
,Iterable<String>
public final class Result
extends Object
implements ArrayInterface, DictionaryInterface, Iterable<String>
Result represents a row of result set returned by a Query.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Tests whether key exists or not.int
count()
getArray
(int index) The result at the given index interpreted as an Array.The result value for the given key as a Array Returns null if the key doesn't exist or if the value is not an ArraygetBlob
(int index) The result at the given index interpreted as a Blob.The result value for the given key as a Blob Returns null if the key doesn't exist or if the value is not a Blobboolean
getBoolean
(int index) The result at the given index interpreted as a boolean.boolean
getBoolean
(String key) The result value for the given key as a boolean Returns null if the key doesn't exist or if the value is not a booleangetDate
(int index) The result at the given index interpreted as a Date.The result value for the given key as a Date Returns null if the key doesn't exist or if the value is not a DategetDictionary
(int index) The result at the given index interpreted as a Dictionary.getDictionary
(String key) The result value for the given key as a Dictionary Returns null if the key doesn't exist or if the value is not a Dictionarydouble
getDouble
(int index) The result at the given index interpreted as a double.double
The result value for the given key as a double Returns 0.0 if the key doesn't exist or if the value is not a doublefloat
getFloat
(int index) The result at the given index interpreted as a float.float
The result value for the given key as a float Returns 0.0F if the key doesn't exist or if the value is not a floatint
getInt
(int index) The result at the given index interpreted as and an int.int
The result value for the given key as an int Returns 0 if the key doesn't exist or if the value is not a intgetKeys()
long
getLong
(int index) The result at the given index interpreted as a long.long
The result value for the given key as a long Returns 0L if the key doesn't exist or if the value is not a longgetNumber
(int index) The result at the given index interpreted as a Number.The result value for the given key as a Number Returns null if the key doesn't exist or if the value is not a NumbergetString
(int index) The result at the given index converted to a StringThe result value for the given key as a String Returns null if the key doesn't exist.getValue
(int index) The result value at the given index.The result value for the given key as an Object Returns null if the key doesn't exist.iterator()
Gets an iterator over the result's keys.toJSON()
toList()
Gets all the values as a List.toMap()
Gets all values as a Map.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
count
public int count()- Specified by:
count
in interfaceArrayInterface
- Specified by:
count
in interfaceDictionaryInterface
- Returns:
- the number of the values in the result.
-
getValue
The result value at the given index.- Specified by:
getValue
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- the value.
-
getString
The result at the given index converted to a String- Specified by:
getString
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a String value.
-
getNumber
The result at the given index interpreted as a Number. Returns null if the value cannot be so interpreted.- Specified by:
getNumber
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Number value.
-
getInt
public int getInt(int index) The result at the given index interpreted as and an int. Returns 0 if the value cannot be so interpreted.- Specified by:
getInt
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- an int value.
-
getLong
public long getLong(int index) The result at the given index interpreted as a long. Returns 0 if the value cannot be so interpreted.- Specified by:
getLong
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a long value.
-
getFloat
public float getFloat(int index) The result at the given index interpreted as a float. Returns 0.0F if the value cannot be so interpreted.- Specified by:
getFloat
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a float value.
-
getDouble
public double getDouble(int index) The result at the given index interpreted as a double. Returns 0.0 if the value cannot be so interpreted.- Specified by:
getDouble
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a double value.
-
getBoolean
public boolean getBoolean(int index) The result at the given index interpreted as a boolean. Returns false if the value cannot be so interpreted.- Specified by:
getBoolean
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a boolean value.
-
getBlob
The result at the given index interpreted as a Blob. Returns null if the value cannot be so interpreted.- Specified by:
getBlob
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Blob.
-
getDate
The result at the given index interpreted as a Date. Returns null if the value cannot be so interpreted.- Specified by:
getDate
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Date.
-
getArray
The result at the given index interpreted as an Array. Returns null if the value cannot be so interpreted.- Specified by:
getArray
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- an Array.
-
getDictionary
The result at the given index interpreted as a Dictionary. Returns null if the value cannot be so interpreted.- Specified by:
getDictionary
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Dictionary.
-
toList
Gets all the values as a List. The types of the values contained in the returned List are Array, Blob, Dictionary, Number types, String, and null.- Specified by:
toList
in interfaceArrayInterface
- Returns:
- a List containing all values.
-
getKeys
- Specified by:
getKeys
in interfaceDictionaryInterface
- Returns:
- a list of keys
-
getValue
The result value for the given key as an Object Returns null if the key doesn't exist.- Specified by:
getValue
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Object.
-
getString
The result value for the given key as a String Returns null if the key doesn't exist.- Specified by:
getString
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The String object.
-
getNumber
The result value for the given key as a Number Returns null if the key doesn't exist or if the value is not a Number- Specified by:
getNumber
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Number object.
-
getInt
The result value for the given key as an int Returns 0 if the key doesn't exist or if the value is not a int- Specified by:
getInt
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The integer value.
-
getLong
The result value for the given key as a long Returns 0L if the key doesn't exist or if the value is not a long- Specified by:
getLong
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The long value.
-
getFloat
The result value for the given key as a float Returns 0.0F if the key doesn't exist or if the value is not a float- Specified by:
getFloat
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The float value.
-
getDouble
The result value for the given key as a double Returns 0.0 if the key doesn't exist or if the value is not a double- Specified by:
getDouble
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The double value.
-
getBoolean
The result value for the given key as a boolean Returns null if the key doesn't exist or if the value is not a boolean- Specified by:
getBoolean
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The boolean value.
-
getBlob
The result value for the given key as a Blob Returns null if the key doesn't exist or if the value is not a Blob- Specified by:
getBlob
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Blob object.
-
getDate
The result value for the given key as a Date Returns null if the key doesn't exist or if the value is not a Date- Specified by:
getDate
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Date object.
-
getArray
The result value for the given key as a Array Returns null if the key doesn't exist or if the value is not an Array- Specified by:
getArray
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Array object.
-
getDictionary
The result value for the given key as a Dictionary Returns null if the key doesn't exist or if the value is not a Dictionary- Specified by:
getDictionary
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Dictionary object.
-
toMap
Gets all values as a Map. The keys in the returned map are the names of columns that have values. The types of the values are Array, Blob, Dictionary, Number types, String, and null.- Specified by:
toMap
in interfaceDictionaryInterface
- Returns:
- The Map representing all values.
-
toJSON
- Specified by:
toJSON
in interfaceArrayInterface
- Specified by:
toJSON
in interfaceDictionaryInterface
-
contains
Tests whether key exists or not.- Specified by:
contains
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- True if exists, otherwise false.
-
iterator
Gets an iterator over the result's keys.
-