com.nifcloud.mbaas.core

Class NCMBQuery<T extends NCMBBase>

java.lang.Object

com.nifcloud.mbaas.core.NCMBQuery<T>

public class NCMBQuery<T extends NCMBBase>
extends java.lang.Object

NCMBQuery is used to search data from NIFCLOUD mobile backend

Constructor Summary

Constructors

Constructor and Description
NCMBQuery(java.lang.String className) Constructor

Method Summary

Modifier and Type	Method and Description
void	addOrderByAscending(java.lang.String key) add Order by ascending with specified key Search Results is sorted in order which key was added.
void	addOrderByDescending(java.lang.String key) add Order by descending with specified key
int	count() return the number of search results
void	countInBackground(CountCallback callback) return number of search results asynchronously
void	deleteOrder(java.lang.String key) remove the specified key sort conditions
java.util.List<T>	find() search data from NIFCLOUD mobile backend
void	findInBackground(FindCallback<T> callback) search data from NIFCLOUD mobile backend asynchronously
org.json.JSONObject	getConditions() get current search condition
void	or(java.util.Collection<NCMBQuery> queries) set the conditions to search the data that matches any one of the given query all queries must be same class name
void	setIncludeKey(java.lang.String key) set to include nested Object of the specified key in the search results
void	setLimit(int number) set the number of acquisition of search results
void	setSkip(int number) set the number to skip the search results
void	whereContainedIn(java.lang.String key, java.util.Collection<? extends java.lang.Object> objects) set the conditions to search the data that contains value of the specified key
void	whereContainedInArray(java.lang.String key, java.util.Collection<? extends java.lang.Object> elements) set the conditions to search the data that contains elements of array in the specified key
void	whereContainsAll(java.lang.String key, java.util.Collection<? extends java.lang.Object> elements) set the conditions to search the data that contains all elements of array in the specified key
void	whereDoesNotExists(java.lang.String key) set the conditions to search the data that specified key exists
void	whereEqualTo(java.lang.String key, java.lang.Object value) set the conditions to search the data that matches the value of the specified key
void	whereExists(java.lang.String key) set the conditions to search the data that specified key exists
void	whereGreaterThan(java.lang.String key, java.lang.Object value) set the conditions to search the data that greater than the value of the specified key
void	whereGreaterThanOrEqualTo(java.lang.String key, java.lang.Object value) set the conditions to search the data that greater than or equal to the value of the specified key
void	whereLessThan(java.lang.String key, java.lang.Object value) set the conditions to search the data that less than the value of the specified key
void	whereLessThanOrEqualTo(java.lang.String key, java.lang.Object value) set the conditions to search the data that less than or equal to the value of the specified key
void	whereMatchesKeyInQuery(java.lang.String key, java.lang.String inQueryKey, NCMBQuery inQuery) set the conditions to search the data that matches inQuery condition and inQueryKey value of the specified key
void	whereMatchesQuery(java.lang.String key, NCMBQuery inQuery) set the conditions to search the data that has pointer that match inQuery condition object
void	whereNotContainedIn(java.lang.String key, java.util.Collection<? extends java.lang.Object> objects) set the conditions to search the data that not contains value of the specified key
void	whereNotContainedInArray(java.lang.String key, java.util.Collection<? extends java.lang.Object> elements) set the conditions to search the data that contains elements of array in the specified key
void	whereNotEqualTo(java.lang.String key, java.lang.Object value) set the conditions to search the data that not matches the value of the specified key
void	whereRelatedTo(NCMBObject parent, java.lang.String key) set the conditions to search the data that related parent object in specified key
void	whereWithinGeoBox(java.lang.String key, android.location.Location southwest, android.location.Location northeast) set the conditions to search the data with location information
void	whereWithinKilometers(java.lang.String key, android.location.Location center, double distance) set the conditions to search the data with location information
void	whereWithinMiles(java.lang.String key, android.location.Location center, int distance) set the conditions to search the data with location information
void	whereWithinRadians(java.lang.String key, android.location.Location center, int distance) set the conditions to search the data with location information

Methods inherited from class java.lang.Object

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

Constructor Detail

NCMBQuery

public NCMBQuery(java.lang.String className)

Constructor

Parameters:

className - class name string for search data

Method Detail

find

public java.util.List<T> find()
                       throws NCMBException

search data from NIFCLOUD mobile backend

Returns:

NCMBObject(include extend class) list of search result

Throws:

NCMBException - exception from NIFCLOUD mobile backend

findInBackground

public void findInBackground(FindCallback<T> callback)

search data from NIFCLOUD mobile backend asynchronously

Parameters:

callback - executed callback after data search

getConditions

public org.json.JSONObject getConditions()

get current search condition

Returns:

current search condition

whereEqualTo

public void whereEqualTo(java.lang.String key,
                         java.lang.Object value)

set the conditions to search the data that matches the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereNotEqualTo

public void whereNotEqualTo(java.lang.String key,
                            java.lang.Object value)

set the conditions to search the data that not matches the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereLessThan

public void whereLessThan(java.lang.String key,
                          java.lang.Object value)

set the conditions to search the data that less than the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereGreaterThan

public void whereGreaterThan(java.lang.String key,
                             java.lang.Object value)

set the conditions to search the data that greater than the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereLessThanOrEqualTo

public void whereLessThanOrEqualTo(java.lang.String key,
                                   java.lang.Object value)

set the conditions to search the data that less than or equal to the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereGreaterThanOrEqualTo

public void whereGreaterThanOrEqualTo(java.lang.String key,
                                      java.lang.Object value)

set the conditions to search the data that greater than or equal to the value of the specified key

Parameters:

key - field name to set the conditions

value - condition value

whereContainedIn

public void whereContainedIn(java.lang.String key,
                             java.util.Collection<? extends java.lang.Object> objects)

set the conditions to search the data that contains value of the specified key

Parameters:

key - field name to set the conditions

objects - condition objects

whereNotContainedIn

public void whereNotContainedIn(java.lang.String key,
                                java.util.Collection<? extends java.lang.Object> objects)

set the conditions to search the data that not contains value of the specified key

Parameters:

key - field name to set the conditions

objects - condition objects

whereExists

public void whereExists(java.lang.String key)

set the conditions to search the data that specified key exists

Parameters:

key - field name to set the conditions

whereDoesNotExists

public void whereDoesNotExists(java.lang.String key)

set the conditions to search the data that specified key exists

Parameters:

key - field name to set the conditions

whereContainedInArray

public void whereContainedInArray(java.lang.String key,
                                  java.util.Collection<? extends java.lang.Object> elements)

set the conditions to search the data that contains elements of array in the specified key

Parameters:

key - field name to set the conditions

elements - condition elements in the specified key array

whereNotContainedInArray

public void whereNotContainedInArray(java.lang.String key,
                                     java.util.Collection<? extends java.lang.Object> elements)

set the conditions to search the data that contains elements of array in the specified key

Parameters:

key - field name to set the conditions

elements - condition elements in the specified key array

whereContainsAll

public void whereContainsAll(java.lang.String key,
                             java.util.Collection<? extends java.lang.Object> elements)

set the conditions to search the data that contains all elements of array in the specified key

Parameters:

key - field name to set the conditions

elements - condition elements in the specified key array

or

public void or(java.util.Collection<NCMBQuery> queries)

set the conditions to search the data that matches any one of the given query all queries must be same class name

Parameters:

queries - condition queries

whereMatchesKeyInQuery

public void whereMatchesKeyInQuery(java.lang.String key,
                                   java.lang.String inQueryKey,
                                   NCMBQuery inQuery)

set the conditions to search the data that matches inQuery condition and inQueryKey value of the specified key

Parameters:

key - field name to set conditions

inQueryKey - condition field name for inQuery

inQuery - condition for Subquery

whereMatchesQuery

public void whereMatchesQuery(java.lang.String key,
                              NCMBQuery inQuery)

set the conditions to search the data that has pointer that match inQuery condition object

Parameters:

key - field name that has pointer for inQuery conditions

inQuery - condition for Subquery

whereRelatedTo

public void whereRelatedTo(NCMBObject parent,
                           java.lang.String key)

set the conditions to search the data that related parent object in specified key

Parameters:

parent - parent NCMBObject(include subclass)

key - field name that has relation to search class data

whereWithinGeoBox

public void whereWithinGeoBox(java.lang.String key,
                              android.location.Location southwest,
                              android.location.Location northeast)

set the conditions to search the data with location information

Parameters:

key - field name that contains location information

southwest - lower left location information for search area

northeast - Upper right location information for search area

whereWithinKilometers

public void whereWithinKilometers(java.lang.String key,
                                  android.location.Location center,
                                  double distance)

set the conditions to search the data with location information

Parameters:

key - field name that contains location information

center - center location for data searching

distance - search radius distance from center point in kilometers

whereWithinMiles

public void whereWithinMiles(java.lang.String key,
                             android.location.Location center,
                             int distance)

set the conditions to search the data with location information

Parameters:

key - field name that contains location information

center - center location for data searching

distance - search radius distance from center point in miles

whereWithinRadians

public void whereWithinRadians(java.lang.String key,
                               android.location.Location center,
                               int distance)

set the conditions to search the data with location information

Parameters:

key - field name that contains location information

center - center location for data searching

distance - search radius distance from center point in radians

setLimit

public void setLimit(int number)

set the number of acquisition of search results

Parameters:

number - number of acquisition (0 ~ 1000)

setSkip

public void setSkip(int number)

set the number to skip the search results

Parameters:

number - number for skipping

setIncludeKey

public void setIncludeKey(java.lang.String key)

set to include nested Object of the specified key in the search results

Parameters:

key - key with pointer to a nested object

addOrderByAscending

public void addOrderByAscending(java.lang.String key)

add Order by ascending with specified key Search Results is sorted in order which key was added.

Parameters:

key - key for order by ascending

addOrderByDescending

public void addOrderByDescending(java.lang.String key)

add Order by descending with specified key

Parameters:

key - key for order by descending

deleteOrder

public void deleteOrder(java.lang.String key)

remove the specified key sort conditions

Parameters:

key - key for remove sort conditions

count

public int count()
          throws NCMBException

return the number of search results

Returns:

number of search results

Throws:

NCMBException - exception from NIFCLOUD mobile backend

countInBackground

public void countInBackground(CountCallback callback)

return number of search results asynchronously

Parameters:

callback - callback for after object search and count results