com.salesforce.androidsdk.smartstore.store

Class IndexSpec

java.lang.Object

com.salesforce.androidsdk.smartstore.store.IndexSpec

public class IndexSpec
extends java.lang.Object

Simple class to represent index spec

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	columnName
java.lang.String	path
SmartStore.Type	type

Constructor Summary

Constructors

Constructor and Description
IndexSpec(java.lang.String path, SmartStore.Type type)
IndexSpec(java.lang.String path, SmartStore.Type type, java.lang.String columnName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static IndexSpec[]	fromJSON(JSONArray jsonArray)
static IndexSpec	fromJSON(JSONObject json) Return IndexSpec given JSONObject
java.lang.String	getPathType()
static boolean	hasFTS(IndexSpec[] indexSpecs)
int	hashCode()
static boolean	hasJSON1(IndexSpec[] indexSpecs)
static java.util.Map<java.lang.String,IndexSpec>	mapForIndexSpecs(IndexSpec[] indexSpecs)
JSONObject	toJSON()
static JSONArray	toJSON(IndexSpec[] indexSpecs)

Methods inherited from class java.lang.Object

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

Field Detail

path

public final java.lang.String path

type

public final SmartStore.Type type

columnName

public final java.lang.String columnName

Constructor Detail

IndexSpec

public IndexSpec(java.lang.String path,
                 SmartStore.Type type)

IndexSpec

public IndexSpec(java.lang.String path,
                 SmartStore.Type type,
                 java.lang.String columnName)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getPathType

public java.lang.String getPathType()

Returns:

path | type

toJSON

public JSONObject toJSON()
                  throws JSONException

Returns:

JSONObject for this IndexSpec

Throws:

JSONException

toJSON

public static JSONArray toJSON(IndexSpec[] indexSpecs)
                        throws JSONException

Parameters:

indexSpecs -

Returns:

JSONArray for the array of IndexSpec's

Throws:

JSONException

fromJSON

public static IndexSpec[] fromJSON(JSONArray jsonArray)
                            throws JSONException

Parameters:

jsonArray -

Returns:

IndexSpec[] from a JSONArray

Throws:

JSONException

fromJSON

public static IndexSpec fromJSON(JSONObject json)
                          throws JSONException

Return IndexSpec given JSONObject

Parameters:

json -

Returns:

Throws:

JSONException

mapForIndexSpecs

public static java.util.Map<java.lang.String,IndexSpec> mapForIndexSpecs(IndexSpec[] indexSpecs)

Parameters:

indexSpecs -

Returns:

map index spec path to index spec

hasFTS

public static boolean hasFTS(IndexSpec[] indexSpecs)

Parameters:

indexSpecs -

Returns:

true if at least one of the indexSpec is of type full_text

hasJSON1

public static boolean hasJSON1(IndexSpec[] indexSpecs)

Parameters:

indexSpecs -

Returns:

true if at least one of the indexSpec is of type json1