com.salesforce.androidsdk.smartstore.config

Class StoreConfig

java.lang.Object

com.salesforce.androidsdk.smartstore.config.StoreConfig

public class StoreConfig
extends java.lang.Object

Class encapsulating a SmartStore schema (soups). Config expected in a resource or assets file in JSON with the following: { soups: [ { soupName: xxx indexes: [ { path: xxx type: xxx } ] } ] }

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEXES
static java.lang.String	SOUP_NAME
static java.lang.String	SOUPS

Constructor Summary

Constructors

Constructor and Description
StoreConfig(Context ctx, int resourceId) Constructor for config stored in resource file
StoreConfig(Context ctx, java.lang.String assetPath) Constructor for config stored in asset file

Method Summary

Modifier and Type	Method and Description
boolean	hasSoups() Return true if soups are defined in config
void	registerSoups(SmartStore store) Register the soup from the config in the given store NB: only feedback is through the logs - the config is static so getting it right is something the developer should do while writing the app

Methods inherited from class java.lang.Object

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

Field Detail

SOUPS

public static final java.lang.String SOUPS

See Also:

Constant Field Values

SOUP_NAME

public static final java.lang.String SOUP_NAME

See Also:

Constant Field Values

INDEXES

public static final java.lang.String INDEXES

See Also:

Constant Field Values

Constructor Detail

StoreConfig

public StoreConfig(Context ctx,
                   int resourceId)

Constructor for config stored in resource file

Parameters:

ctx - Context.

resourceId - Id of resource file.

StoreConfig

public StoreConfig(Context ctx,
                   java.lang.String assetPath)

Constructor for config stored in asset file

Parameters:

ctx - Context.

assetPath - Path of assets file.

Method Detail

hasSoups

public boolean hasSoups()

Return true if soups are defined in config

Returns:

registerSoups

public void registerSoups(SmartStore store)

Register the soup from the config in the given store NB: only feedback is through the logs - the config is static so getting it right is something the developer should do while writing the app

Parameters:

store -