io.realm

Class RealmQuery<E extends RealmObject>

java.lang.Object

io.realm.RealmQuery<E>

Type Parameters:

E - The class of the objects to be queried.

public class RealmQuery<E extends RealmObject>
extends java.lang.Object

A RealmQuery encapsulates a query on a Realm or a RealmResults using the Builder pattern. The query is executed using either findAll() or findFirst()

The input to many of the query functions take a field name as String. Note that this is not type safe. If a model class is refactored care has to be taken to not break any queries.

A Realm is unordered, which means that there is no guarantee that querying a Realm will return the objects in the order they where inserted. Use findAllSorted(String) and similar methods if a specific order is required.

A RealmQuery cannot be passed between different threads.

See Also:

Builder pattern, Realm.where(Class), RealmResults.where()

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CASE_INSENSITIVE
static boolean	CASE_SENSITIVE

Constructor Summary

Constructors

Constructor and Description
RealmQuery(Realm realm, java.lang.Class<E> clazz) Creating a RealmQuery instance.
RealmQuery(RealmResults realmList, java.lang.Class<E> clazz) Create a RealmQuery instance from a @{link io.realm.RealmResults}.

Method Summary

Modifier and Type	Method and Description
double	average(java.lang.String fieldName) Returns the average of a given field.
double	averageDouble(java.lang.String fieldName) Deprecated. Please use average(String) instead.
double	averageFloat(java.lang.String fieldName) Deprecated. Please use average(String) instead.
double	averageInt(java.lang.String fieldName) Deprecated. Please use average(String) instead.
RealmQuery<E>	beginGroup() Begin grouping of conditions ("left parenthesis").
RealmQuery<E>	beginsWith(java.lang.String fieldName, java.lang.String value) Condition that the value of field begins with the specified string
RealmQuery<E>	beginsWith(java.lang.String fieldName, java.lang.String value, boolean caseSensitive) Condition that the value of field begins with the specified substring
RealmQuery<E>	between(java.lang.String fieldName, java.util.Date from, java.util.Date to) Between condition
RealmQuery<E>	between(java.lang.String fieldName, double from, double to) Between condition
RealmQuery<E>	between(java.lang.String fieldName, float from, float to) Between condition
RealmQuery<E>	between(java.lang.String fieldName, int from, int to) Between condition
RealmQuery<E>	between(java.lang.String fieldName, long from, long to) Between condition
RealmQuery<E>	contains(java.lang.String fieldName, java.lang.String value) Condition that value of field contains the specified substring
RealmQuery<E>	contains(java.lang.String fieldName, java.lang.String value, boolean caseSensitive) Condition that value of field contains the specified substring
long	count() Count the number of objects that fulfill the query conditions.
RealmQuery<E>	endGroup() End grouping of conditions ("right parenthesis") which was opened by a call to beginGroup().
RealmQuery<E>	endsWith(java.lang.String fieldName, java.lang.String value) Condition that the value of field ends with the specified string
RealmQuery<E>	endsWith(java.lang.String fieldName, java.lang.String value, boolean caseSensitive) Condition that the value of field ends with the specified substring
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Boolean value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Byte value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.util.Date value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Double value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Float value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Integer value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Long value) Equal-to comparison
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Short value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.String value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.String value, boolean caseSensitive) Equal-to comparison.
RealmResults<E>	findAll() Find all objects that fulfill the query conditions.
RealmResults<E>	findAllSorted(java.lang.String fieldName) Find all objects that fulfill the query conditions and sorted by specific field name in ascending order.
RealmResults<E>	findAllSorted(java.lang.String[] fieldNames, boolean[] sortAscending) Find all objects that fulfill the query conditions and sorted by specific field names.
RealmResults<E>	findAllSorted(java.lang.String fieldName, boolean sortAscending) Find all objects that fulfill the query conditions and sorted by specific field name.
RealmResults<E>	findAllSorted(java.lang.String fieldName1, boolean sortAscending1, java.lang.String fieldName2, boolean sortAscending2) Find all objects that fulfill the query conditions and sorted by specific field names in ascending order.
RealmResults<E>	findAllSorted(java.lang.String fieldName1, boolean sortAscending1, java.lang.String fieldName2, boolean sortAscending2, java.lang.String fieldName3, boolean sortAscending3) Find all objects that fulfill the query conditions and sorted by specific field names in ascending order.
E	findFirst() Find the first object that fulfills the query conditions.
RealmQuery<E>	greaterThan(java.lang.String fieldName, java.util.Date value) Greater-than comparison
RealmQuery<E>	greaterThan(java.lang.String fieldName, double value) Greater-than comparison
RealmQuery<E>	greaterThan(java.lang.String fieldName, float value) Greater-than comparison
RealmQuery<E>	greaterThan(java.lang.String fieldName, int value) Greater-than comparison
RealmQuery<E>	greaterThan(java.lang.String fieldName, long value) Greater-than comparison
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, java.util.Date value) Greater-than-or-equal-to comparison
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, double value) Greater-than-or-equal-to comparison
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, float value) Greater-than-or-equal-to comparison
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, int value) Greater-than-or-equal-to comparison
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, long value) Greater-than-or-equal-to comparison
RealmQuery<E>	isNotNull(java.lang.String fieldName) Test if a field is not null.
RealmQuery<E>	isNull(java.lang.String fieldName) Test if a field is null.
RealmQuery<E>	lessThan(java.lang.String fieldName, java.util.Date value) Less-than comparison
RealmQuery<E>	lessThan(java.lang.String fieldName, double value) Less-than comparison
RealmQuery<E>	lessThan(java.lang.String fieldName, float value) Less-than comparison
RealmQuery<E>	lessThan(java.lang.String fieldName, int value) Less-than comparison
RealmQuery<E>	lessThan(java.lang.String fieldName, long value) Less-than comparison
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, java.util.Date value) Less-than-or-equal-to comparison
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, double value) Less-than-or-equal-to comparison
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, float value) Less-than-or-equal-to comparison
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, int value) Less-than-or-equal-to comparison
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, long value) Less-than-or-equal-to comparison
java.lang.Number	max(java.lang.String fieldName) Find the maximum value of a field.
java.util.Date	maximumDate(java.lang.String fieldName) Find the maximum value of a field.
double	maximumDouble(java.lang.String fieldName) Deprecated. Please use max(String) instead.
float	maximumFloat(java.lang.String fieldName) Deprecated. Please use max(String) instead.
long	maximumInt(java.lang.String fieldName) Deprecated. Please use max(String) instead.
java.lang.Number	min(java.lang.String fieldName) Find the minimum value of a field.
java.util.Date	minimumDate(java.lang.String fieldName) Find the minimum value of a field
double	minimumDouble(java.lang.String fieldName) Deprecated. Please use min(String) instead.
float	minimumFloat(java.lang.String fieldName) Deprecated. Please use min(String) instead.
long	minimumInt(java.lang.String fieldName) Deprecated. Please use min(String) instead.
RealmQuery<E>	not() Negate condition.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Boolean value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Byte value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.util.Date value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Double value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Float value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Integer value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Long value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Short value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.String value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.String value, boolean caseSensitive) Not-equal-to comparison.
RealmQuery<E>	or() Logical-or two conditions
java.lang.Number	sum(java.lang.String fieldName) Calculate the sum of a given field.
double	sumDouble(java.lang.String fieldName) Deprecated. Please use sum(String) instead.
double	sumFloat(java.lang.String fieldName) Deprecated. Please use sum(String) instead.
long	sumInt(java.lang.String fieldName) Deprecated. Please use sum(String) instead.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CASE_SENSITIVE

public static final boolean CASE_SENSITIVE

See Also:

Constant Field Values

CASE_INSENSITIVE

public static final boolean CASE_INSENSITIVE

See Also:

Constant Field Values

Constructor Detail

RealmQuery

public RealmQuery(Realm realm,
                  java.lang.Class<E> clazz)

Creating a RealmQuery instance.

Parameters:

realm - The realm to query within.

clazz - The class to query.

Throws:

java.lang.RuntimeException - Any other error.

RealmQuery

public RealmQuery(RealmResults realmList,
                  java.lang.Class<E> clazz)

Create a RealmQuery instance from a @{link io.realm.RealmResults}.

Parameters:

realmList - The @{link io.realm.RealmResults} to query

clazz - The class to query

Throws:

java.lang.RuntimeException - Any other error

Method Detail

isNull

public RealmQuery<E> isNull(java.lang.String fieldName)

Test if a field is null. Only works for nullable fields.

Parameters:

fieldName - the field name.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field is not nullable.

See Also:

for further infomation.

isNotNull

public RealmQuery<E> isNotNull(java.lang.String fieldName)

Test if a field is not null. Only works for nullable fields.

Parameters:

fieldName - the field name.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field is not nullable.

See Also:

for further infomation.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.String value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.String value,
                             boolean caseSensitive)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

caseSensitive - if true, substring matching is case sensitive. Setting this to false only works for English locale characters.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Byte value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Short value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Integer value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Long value)

Equal-to comparison

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Double value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Float value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

The query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Boolean value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.util.Date value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.String value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.String value,
                                boolean caseSensitive)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

caseSensitive - if true, substring matching is case sensitive. Setting this to false only works for English locale characters.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Byte value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Short value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Integer value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Long value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Double value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Float value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Boolean value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.util.Date value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

java.lang.RuntimeException - if any other error happens.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 int value)

Greater-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 long value)

Greater-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 double value)

Greater-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 float value)

Greater-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 java.util.Date value)

Greater-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          int value)

Greater-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          long value)

Greater-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          double value)

Greater-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          float value)

Greater-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          java.util.Date value)

Greater-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              int value)

Less-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              long value)

Less-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              double value)

Less-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              float value)

Less-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              java.util.Date value)

Less-than comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       int value)

Less-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       long value)

Less-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       double value)

Less-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       float value)

Less-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       java.util.Date value)

Less-than-or-equal-to comparison

Parameters:

fieldName - The field to compare

value - The value to compare with

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

between

public RealmQuery<E> between(java.lang.String fieldName,
                             int from,
                             int to)

Between condition

Parameters:

fieldName - The field to compare

from - Lowest value (inclusive)

to - Highest value (inclusive)

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

between

public RealmQuery<E> between(java.lang.String fieldName,
                             long from,
                             long to)

Between condition

Parameters:

fieldName - The field to compare

from - Lowest value (inclusive)

to - Highest value (inclusive)

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

between

public RealmQuery<E> between(java.lang.String fieldName,
                             double from,
                             double to)

Between condition

Parameters:

fieldName - The field to compare

from - Lowest value (inclusive)

to - Highest value (inclusive)

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

between

public RealmQuery<E> between(java.lang.String fieldName,
                             float from,
                             float to)

Between condition

Parameters:

fieldName - The field to compare

from - Lowest value (inclusive)

to - Highest value (inclusive)

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

between

public RealmQuery<E> between(java.lang.String fieldName,
                             java.util.Date from,
                             java.util.Date to)

Between condition

Parameters:

fieldName - The field to compare

from - Lowest value (inclusive)

to - Highest value (inclusive)

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

contains

public RealmQuery<E> contains(java.lang.String fieldName,
                              java.lang.String value)

Condition that value of field contains the specified substring

Parameters:

fieldName - The field to compare

value - The substring

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

contains

public RealmQuery<E> contains(java.lang.String fieldName,
                              java.lang.String value,
                              boolean caseSensitive)

Condition that value of field contains the specified substring

Parameters:

fieldName - The field to compare

value - The substring

caseSensitive - if true, substring matching is case sensitive. Setting this to false only works for English locale characters.

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

beginsWith

public RealmQuery<E> beginsWith(java.lang.String fieldName,
                                java.lang.String value)

Condition that the value of field begins with the specified string

Parameters:

fieldName - The field to compare

value - The string

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

beginsWith

public RealmQuery<E> beginsWith(java.lang.String fieldName,
                                java.lang.String value,
                                boolean caseSensitive)

Condition that the value of field begins with the specified substring

Parameters:

fieldName - The field to compare

value - The substring

caseSensitive - if true, substring matching is case sensitive. Setting this to false only works for English locale characters.

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

endsWith

public RealmQuery<E> endsWith(java.lang.String fieldName,
                              java.lang.String value)

Condition that the value of field ends with the specified string

Parameters:

fieldName - The field to compare

value - The string

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

endsWith

public RealmQuery<E> endsWith(java.lang.String fieldName,
                              java.lang.String value,
                              boolean caseSensitive)

Condition that the value of field ends with the specified substring

Parameters:

fieldName - The field to compare

value - The substring

caseSensitive - if true, substring matching is case sensitive. Setting this to false only works for English locale characters.

Returns:

The query object

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type

java.lang.RuntimeException - Any other error

beginGroup

public RealmQuery<E> beginGroup()

Begin grouping of conditions ("left parenthesis"). A group must be closed with a call to endGroup().

Returns:

The query object

See Also:

endGroup()

endGroup

public RealmQuery<E> endGroup()

End grouping of conditions ("right parenthesis") which was opened by a call to beginGroup().

Returns:

The query object

See Also:

beginGroup()

or

public RealmQuery<E> or()

Logical-or two conditions

Returns:

The query object

not

public RealmQuery<E> not()

Negate condition.

Returns:

The query object

sum

public java.lang.Number sum(java.lang.String fieldName)

Calculate the sum of a given field.

Parameters:

fieldName - the field to sum. Only number fields are supported.

Returns:

the sum. If no objects exist or they all have null as the value for the given field, 0 will be returned. When computing the sum, objects with null values are ignored.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

sumInt

public long sumInt(java.lang.String fieldName)

Deprecated. Please use sum(String) instead.

Calculate the sum of a field

Parameters:

fieldName - The field name

Returns:

The sum

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

sumDouble

public double sumDouble(java.lang.String fieldName)

Deprecated. Please use sum(String) instead.

Calculate the sum of a field

Parameters:

fieldName - The field name

Returns:

The sum

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

sumFloat

public double sumFloat(java.lang.String fieldName)

Deprecated. Please use sum(String) instead.

Calculate the sum of a field

Parameters:

fieldName - The field name

Returns:

The sum

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

average

public double average(java.lang.String fieldName)

Returns the average of a given field.

Parameters:

fieldName - the field to calculate average on. Only number fields are supported.

Returns:

The average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have null as the value for the given field, 0 will be returned. When computing the average, objects with null values are ignored.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

averageInt

public double averageInt(java.lang.String fieldName)

Deprecated. Please use average(String) instead.

Calculate the average of a field

Parameters:

fieldName - The field name

Returns:

The average

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

averageDouble

public double averageDouble(java.lang.String fieldName)

Deprecated. Please use average(String) instead.

Calculate the average of a field

Parameters:

fieldName - The field name

Returns:

The average

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

averageFloat

public double averageFloat(java.lang.String fieldName)

Deprecated. Please use average(String) instead.

Calculate the average of a field

Parameters:

fieldName - The field name

Returns:

The average

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

min

public java.lang.Number min(java.lang.String fieldName)

Find the minimum value of a field.

Parameters:

fieldName - the field to look for a minimum on. Only number fields are supported.

Returns:

if no objects exist or they all have null as the value for the given field, null will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with null values are ignored.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

minimumInt

public long minimumInt(java.lang.String fieldName)

Deprecated. Please use min(String) instead.

Find the minimum value of a field

Parameters:

fieldName - The field name

Returns:

The minimum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

minimumDouble

public double minimumDouble(java.lang.String fieldName)

Deprecated. Please use min(String) instead.

Find the minimum value of a field

Parameters:

fieldName - The field name

Returns:

The minimum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

minimumFloat

public float minimumFloat(java.lang.String fieldName)

Deprecated. Please use min(String) instead.

Find the minimum value of a field

Parameters:

fieldName - The field name

Returns:

The minimum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

minimumDate

public java.util.Date minimumDate(java.lang.String fieldName)

Find the minimum value of a field

Parameters:

fieldName - The field name

Returns:

If no objects exist or they all have null as the value for the given date field, null will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with null values are ignored.

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

max

public java.lang.Number max(java.lang.String fieldName)

Find the maximum value of a field.

Parameters:

fieldName - the field to look for a maximum on. Only number fields are supported.

Returns:

if no objects exist or they all have null as the value for the given field, null will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with null values are ignored.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

maximumInt

public long maximumInt(java.lang.String fieldName)

Deprecated. Please use max(String) instead.

Find the maximum value of a field

Parameters:

fieldName - The field name

Returns:

The maximum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

maximumDouble

public double maximumDouble(java.lang.String fieldName)

Deprecated. Please use max(String) instead.

Find the maximum value of a field

Parameters:

fieldName - The field name

Returns:

The maximum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

maximumFloat

public float maximumFloat(java.lang.String fieldName)

Deprecated. Please use max(String) instead.

Find the maximum value of a field

Parameters:

fieldName - The field name

Returns:

The maximum value

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

java.lang.NullPointerException - if no objects exist or they all have null as the value for the given field.

maximumDate

public java.util.Date maximumDate(java.lang.String fieldName)

Find the maximum value of a field.

Parameters:

fieldName - the field name.

Returns:

if no objects exist or they all have null as the value for the given date field, null will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with null values are ignored.

Throws:

java.lang.UnsupportedOperationException - the query is not valid ("syntax error").

count

public long count()

Count the number of objects that fulfill the query conditions.

Returns:

The number of matching objects.

Throws:

java.lang.UnsupportedOperationException - The query is not valid ("syntax error")

findAll

public RealmResults<E> findAll()

Find all objects that fulfill the query conditions.

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.RuntimeException - Any other error

See Also:

RealmResults

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName,
                                     boolean sortAscending)

Find all objects that fulfill the query conditions and sorted by specific field name. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName - the field name to sort by.

sortAscending - sort ascending if SORT_ORDER_ASCENDING, sort descending if SORT_ORDER_DESCENDING

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if field name does not exist.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName)

Find all objects that fulfill the query conditions and sorted by specific field name in ascending order. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName - the field name to sort by.

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if field name does not exist.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String[] fieldNames,
                                     boolean[] sortAscending)

Find all objects that fulfill the query conditions and sorted by specific field names. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldNames - an array of field names to sort by.

sortAscending - sort ascending if SORT_ORDER_ASCENDING, sort descending if SORT_ORDER_DESCENDING.

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if a field name does not exist.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName1,
                                     boolean sortAscending1,
                                     java.lang.String fieldName2,
                                     boolean sortAscending2)

Find all objects that fulfill the query conditions and sorted by specific field names in ascending order. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName1 - first field name

sortAscending1 - sort order for first field

fieldName2 - second field name

sortAscending2 - sort order for second field

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if a field name does not exist.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName1,
                                     boolean sortAscending1,
                                     java.lang.String fieldName2,
                                     boolean sortAscending2,
                                     java.lang.String fieldName3,
                                     boolean sortAscending3)

Find all objects that fulfill the query conditions and sorted by specific field names in ascending order. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName1 - first field name

sortAscending1 - sort order for first field

fieldName2 - second field name

sortAscending2 - sort order for second field

fieldName3 - third field name

sortAscending3 - sort order for third field

Returns:

A RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if a field name does not exist.

findFirst

public E findFirst()

Find the first object that fulfills the query conditions.

Returns:

The object found or null if no object matches the query conditions.

Throws:

java.lang.RuntimeException - Any other error.

See Also:

RealmObject