org.restonfire

Interface FirebaseRestQuery

public interface FirebaseRestQuery

A FirebaseRestQuery is create by a FirebaseRestReference and represents the same location as the creating REST reference. It allows for querying the location with the various different sort and filter mechanisms that Firebase supports.

For a full understanding of the behaviour of this class, please visit Firebase's documentation for more details.
Firebase's old documentation is also a great resource to understand the behaviour of the supported methods.

See Also:

Firebase Filtering Data Documentation

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all previously provided sorting and filtering values.
FirebaseRestQuery	endAt(java.lang.Object value) Return items less than or equal to the specified key, value, or priority, depending on the order-by method chosen.
FirebaseRestQuery	equalTo(java.lang.Object value) Return items equal to the specified key, value, or priority, depending on the order-by method chosen.
FirebaseRestQuery	limitToFirst(int number) Sets the maximum number of items to return from the beginning of the ordered list of results.
FirebaseRestQuery	limitToLast(int number) Sets the maximum number of items to return from the end of the ordered list of results.
FirebaseRestQuery	orderByChild(java.lang.String name) Order results by the value of a specified child name.
FirebaseRestQuery	orderByKey() Order results by child keys.
FirebaseRestQuery	orderByPriority() Order results by the assigned priority.
FirebaseRestQuery	orderByValue() Order results by child values.
<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void>	run(java.lang.Class<T> clazz) Executes the query with the previously provided sorting and filtering arguments.
FirebaseRestQuery	startAt(java.lang.Object value) Return items greater than or equal to the specified key, value, or priority, depending on the order-by method chosen.

Method Detail

startAt

FirebaseRestQuery startAt(java.lang.Object value)

Return items greater than or equal to the specified key, value, or priority, depending on the order-by method chosen. All values less (or before) the given value will be removed from the result.

Parameters:

value - The starting value of the result set.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Complex Filtering Documentation

endAt

FirebaseRestQuery endAt(java.lang.Object value)

Return items less than or equal to the specified key, value, or priority, depending on the order-by method chosen. All values greater (or after) the given value will be removed from the result.

Parameters:

value - The ending value of the result set.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Complex Filtering Documentation

equalTo

FirebaseRestQuery equalTo(java.lang.Object value)

Return items equal to the specified key, value, or priority, depending on the order-by method chosen. All other values will be removed from the result.

Parameters:

value - The value all results must be equal to.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Complex Filtering Documentation

limitToFirst

FirebaseRestQuery limitToFirst(int number)

Sets the maximum number of items to return from the beginning of the ordered list of results. All other values will be removed from the result.

Parameters:

number - Number of results to be returned.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Complex Filtering Documentation

limitToLast

FirebaseRestQuery limitToLast(int number)

Sets the maximum number of items to return from the end of the ordered list of results. All other values will be removed from the result.

Parameters:

number - Number of results to be returned.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Complex Filtering Documentation

orderByKey

FirebaseRestQuery orderByKey()

Order results by child keys. This is particularly useful for non-generated keys.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Order By Key Documentation

orderByChild

FirebaseRestQuery orderByChild(java.lang.String name)

Order results by the value of a specified child name.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Order By Documentation

orderByPriority

FirebaseRestQuery orderByPriority()

Order results by the assigned priority.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Order By Priority Documentation

orderByValue

FirebaseRestQuery orderByValue()

Order results by child values.

Returns:

This FirebaseRestQuery reference.

See Also:

Firebase Order By Value Documentation

clear

void clear()

Removes all previously provided sorting and filtering values. This resets the query and alternative values can now be used.

run

<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void> run(java.lang.Class<T> clazz)

Executes the query with the previously provided sorting and filtering arguments. The function can be invoked multiple times to re-run the same query over and over again.

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned or the deserialization of the response into the type parameter fails.

Type Parameters:

T - The type of the result object.

Parameters:

clazz - The Class type for the POJO to be created for the data returned by the request.

Returns:

A promise which will be resolved with the POJO generated from the response if the request was successful.