com.salesforce.androidsdk.smartstore.store

Class QuerySpec

java.lang.Object

com.salesforce.androidsdk.smartstore.store.QuerySpec

public class QuerySpec
extends java.lang.Object

Simple class to represent a query spec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuerySpec.Order Simple class to represent query order
static class	QuerySpec.QueryType Query type enum

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEGIN_KEY
java.lang.String	beginKey
java.lang.String	countSmartSql
static java.lang.String	END_KEY
java.lang.String	endKey
java.lang.String	idsSmartSql
static java.lang.String	INDEX_PATH
static java.lang.String	LIKE_KEY
java.lang.String	likeKey
static java.lang.String	MATCH_KEY
java.lang.String	matchKey
QuerySpec.Order	order
static java.lang.String	ORDER
static java.lang.String	ORDER_PATH
java.lang.String	orderPath
static java.lang.String	PAGE_SIZE
int	pageSize
java.lang.String	path
static java.lang.String	QUERY_TYPE
QuerySpec.QueryType	queryType
static java.lang.String	SELECT_PATHS
java.lang.String[]	selectPaths
static java.lang.String	SMART_SQL
java.lang.String	smartSql
java.lang.String	soupName

Method Summary

Modifier and Type	Method and Description
static QuerySpec	buildAllQuerySpec(java.lang.String soupName, java.lang.String[] selectPaths, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return query spec for an all query
static QuerySpec	buildAllQuerySpec(java.lang.String soupName, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return query spec for an all query
static QuerySpec	buildExactQuerySpec(java.lang.String soupName, java.lang.String[] selectPaths, java.lang.String path, java.lang.String exactMatchKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for an exact match query
static QuerySpec	buildExactQuerySpec(java.lang.String soupName, java.lang.String path, java.lang.String exactMatchKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for an exact match query
static QuerySpec	buildLikeQuerySpec(java.lang.String soupName, java.lang.String[] selectPaths, java.lang.String path, java.lang.String likeKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a like query
static QuerySpec	buildLikeQuerySpec(java.lang.String soupName, java.lang.String path, java.lang.String likeKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a like query
static QuerySpec	buildMatchQuerySpec(java.lang.String soupName, java.lang.String[] selectPaths, java.lang.String path, java.lang.String matchKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a match query (full-text search)
static QuerySpec	buildMatchQuerySpec(java.lang.String soupName, java.lang.String path, java.lang.String matchKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a match query (full-text search)
static QuerySpec	buildRangeQuerySpec(java.lang.String soupName, java.lang.String[] selectPaths, java.lang.String path, java.lang.String beginKey, java.lang.String endKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a range query
static QuerySpec	buildRangeQuerySpec(java.lang.String soupName, java.lang.String path, java.lang.String beginKey, java.lang.String endKey, java.lang.String orderPath, QuerySpec.Order order, int pageSize) Return a query spec for a range query
static QuerySpec	buildSmartQuerySpec(java.lang.String smartSql, int pageSize) Return a query spec for a smart query
static QuerySpec	fromJSON(java.lang.String soupName, JSONObject querySpecJson)
java.lang.String[]	getArgs()
static java.lang.String	qualifyMatchKey(java.lang.String field, java.lang.String matchKey) fts5 doesn't allow WHERE column MATCH 'value' - only allows WHERE table MATCH 'column:value' This method changes the matchKey to add field: in the right places

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN_KEY

public static final java.lang.String BEGIN_KEY

See Also:

Constant Field Values

END_KEY

public static final java.lang.String END_KEY

See Also:

Constant Field Values

INDEX_PATH

public static final java.lang.String INDEX_PATH

See Also:

Constant Field Values

LIKE_KEY

public static final java.lang.String LIKE_KEY

See Also:

Constant Field Values

MATCH_KEY

public static final java.lang.String MATCH_KEY

See Also:

Constant Field Values

SMART_SQL

public static final java.lang.String SMART_SQL

See Also:

Constant Field Values

ORDER_PATH

public static final java.lang.String ORDER_PATH

See Also:

Constant Field Values

ORDER

public static final java.lang.String ORDER

See Also:

Constant Field Values

PAGE_SIZE

public static final java.lang.String PAGE_SIZE

See Also:

Constant Field Values

QUERY_TYPE

public static final java.lang.String QUERY_TYPE

See Also:

Constant Field Values

SELECT_PATHS

public static final java.lang.String SELECT_PATHS

See Also:

Constant Field Values

queryType

public final QuerySpec.QueryType queryType

pageSize

public final int pageSize

smartSql

public final java.lang.String smartSql

countSmartSql

public final java.lang.String countSmartSql

idsSmartSql

public final java.lang.String idsSmartSql

soupName

public final java.lang.String soupName

selectPaths

public final java.lang.String[] selectPaths

path

public final java.lang.String path

orderPath

public final java.lang.String orderPath

order

public final QuerySpec.Order order

matchKey

public final java.lang.String matchKey

beginKey

public final java.lang.String beginKey

endKey

public final java.lang.String endKey

likeKey

public final java.lang.String likeKey

Method Detail

buildAllQuerySpec

public static QuerySpec buildAllQuerySpec(java.lang.String soupName,
                                          java.lang.String orderPath,
                                          QuerySpec.Order order,
                                          int pageSize)

Return query spec for an all query

Parameters:

soupName -

orderPath -

order -

pageSize -

Returns:

buildAllQuerySpec

public static QuerySpec buildAllQuerySpec(java.lang.String soupName,
                                          java.lang.String[] selectPaths,
                                          java.lang.String orderPath,
                                          QuerySpec.Order order,
                                          int pageSize)

Return query spec for an all query

Parameters:

soupName -

selectPaths -

orderPath -

order -

pageSize -

Returns:

buildExactQuerySpec

public static QuerySpec buildExactQuerySpec(java.lang.String soupName,
                                            java.lang.String path,
                                            java.lang.String exactMatchKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for an exact match query

Parameters:

soupName -

path -

exactMatchKey -

orderPath -

order -

pageSize -

Returns:

buildExactQuerySpec

public static QuerySpec buildExactQuerySpec(java.lang.String soupName,
                                            java.lang.String[] selectPaths,
                                            java.lang.String path,
                                            java.lang.String exactMatchKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for an exact match query

Parameters:

soupName -

selectPaths -

path -

exactMatchKey -

orderPath -

order -

pageSize -

Returns:

buildRangeQuerySpec

public static QuerySpec buildRangeQuerySpec(java.lang.String soupName,
                                            java.lang.String path,
                                            java.lang.String beginKey,
                                            java.lang.String endKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for a range query

Parameters:

soupName -

path -

beginKey -

endKey -

orderPath -

order -

pageSize -

Returns:

buildRangeQuerySpec

public static QuerySpec buildRangeQuerySpec(java.lang.String soupName,
                                            java.lang.String[] selectPaths,
                                            java.lang.String path,
                                            java.lang.String beginKey,
                                            java.lang.String endKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for a range query

Parameters:

soupName -

selectPaths -

path -

beginKey -

endKey -

orderPath -

order -

pageSize -

Returns:

buildLikeQuerySpec

public static QuerySpec buildLikeQuerySpec(java.lang.String soupName,
                                           java.lang.String path,
                                           java.lang.String likeKey,
                                           java.lang.String orderPath,
                                           QuerySpec.Order order,
                                           int pageSize)

Return a query spec for a like query

Parameters:

soupName -

path -

likeKey -

orderPath -

order -

pageSize -

Returns:

buildLikeQuerySpec

public static QuerySpec buildLikeQuerySpec(java.lang.String soupName,
                                           java.lang.String[] selectPaths,
                                           java.lang.String path,
                                           java.lang.String likeKey,
                                           java.lang.String orderPath,
                                           QuerySpec.Order order,
                                           int pageSize)

Return a query spec for a like query

Parameters:

soupName -

selectPaths -

path -

likeKey -

orderPath -

order -

pageSize -

Returns:

buildMatchQuerySpec

public static QuerySpec buildMatchQuerySpec(java.lang.String soupName,
                                            java.lang.String path,
                                            java.lang.String matchKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for a match query (full-text search)

Parameters:

soupName -

path -

matchKey -

orderPath -

order -

pageSize -

Returns:

buildMatchQuerySpec

public static QuerySpec buildMatchQuerySpec(java.lang.String soupName,
                                            java.lang.String[] selectPaths,
                                            java.lang.String path,
                                            java.lang.String matchKey,
                                            java.lang.String orderPath,
                                            QuerySpec.Order order,
                                            int pageSize)

Return a query spec for a match query (full-text search)

Parameters:

soupName -

selectPaths -

path -

matchKey -

orderPath -

order -

pageSize -

Returns:

buildSmartQuerySpec

public static QuerySpec buildSmartQuerySpec(java.lang.String smartSql,
                                            int pageSize)

Return a query spec for a smart query

Parameters:

smartSql -

pageSize -

Returns:

qualifyMatchKey

public static java.lang.String qualifyMatchKey(java.lang.String field,
                                               java.lang.String matchKey)

fts5 doesn't allow WHERE column MATCH 'value' - only allows WHERE table MATCH 'column:value' This method changes the matchKey to add field: in the right places

Parameters:

field -

matchKey -

Returns:

getArgs

public java.lang.String[] getArgs()

Returns:

args going with the sql predicate returned by getKeyPredicate

fromJSON

public static QuerySpec fromJSON(java.lang.String soupName,
                                 JSONObject querySpecJson)
                          throws JSONException

Parameters:

soupName -

querySpecJson -

Returns:

Throws:

JSONException