com.salesforce.androidsdk.smartstore.store

Class AlterSoupLongOperation

java.lang.Object

com.salesforce.androidsdk.smartstore.store.LongOperation

com.salesforce.androidsdk.smartstore.store.AlterSoupLongOperation

public class AlterSoupLongOperation
extends LongOperation

Class taking care of alter soup Two entry points: - new AlterSoupLongOperation(...) + run() => when asked to alterSoup in SmartStore - LongOperation.getOperation(...) + run() => when completing interrupted long operations when opening the database

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlterSoupLongOperation.AlterSoupStep Enum for alter steps

Nested classes/interfaces inherited from class com.salesforce.androidsdk.smartstore.store.LongOperation

LongOperation.LongOperationType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	soupName
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
AlterSoupLongOperation() Default constructor when reading back from long operations status table Should be followed by a call to: initFromDbRow
AlterSoupLongOperation(SmartStore store, java.lang.String soupName, IndexSpec[] newIndexSpecs, boolean reIndexData) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	copyTable() Step 4: copy data from old soup table to new soup table
protected long	createLongOperationDbRow() Create row in long operations status table for a new alter soup operation
protected void	dropOldIndexes() Step 2: drop old indexes / remove entries in soup_index_map / cleaanup cache
protected void	dropOldTable() Step 6: drop old soup table
JSONObject	getDetails()
AlterSoupLongOperation.AlterSoupStep	getLastStepCompleted()
protected void	initFromDbRow(SmartStore store, long rowId, JSONObject details, java.lang.String statusStr)
protected void	registerSoupUsingTableName() Step 3: register soup with new indexes
protected void	reIndexSoup() Step 5: re-index soup for new indexes (optional step)
protected void	renameOldSoupTable() Step 1: rename old table
void	run() Run long operation
void	run(AlterSoupLongOperation.AlterSoupStep toStep) Used by test only
protected void	updateLongOperationDbRow(AlterSoupLongOperation.AlterSoupStep newStatus) Update row in long operations status table for on-going alter soup operation Delete row if newStatus is AlterStatus.LAST

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

soupName

protected java.lang.String soupName

Constructor Detail

AlterSoupLongOperation

public AlterSoupLongOperation()

Default constructor when reading back from long operations status table Should be followed by a call to: initFromDbRow

AlterSoupLongOperation

public AlterSoupLongOperation(SmartStore store,
                              java.lang.String soupName,
                              IndexSpec[] newIndexSpecs,
                              boolean reIndexData)
                       throws JSONException

Constructor

Parameters:

store -

soupName -

newIndexSpecs -

reIndexData -

Throws:

JSONException

Method Detail

run

public void run()

Description copied from class: LongOperation

Run long operation

Specified by:

run in class LongOperation

run

public void run(AlterSoupLongOperation.AlterSoupStep toStep)

Used by test only

Parameters:

toStep -

getLastStepCompleted

public AlterSoupLongOperation.AlterSoupStep getLastStepCompleted()

Returns:

last step completed

initFromDbRow

protected void initFromDbRow(SmartStore store,
                             long rowId,
                             JSONObject details,
                             java.lang.String statusStr)
                      throws JSONException

Specified by:

initFromDbRow in class LongOperation

Throws:

JSONException

renameOldSoupTable

protected void renameOldSoupTable()

Step 1: rename old table

dropOldIndexes

protected void dropOldIndexes()

Step 2: drop old indexes / remove entries in soup_index_map / cleaanup cache

registerSoupUsingTableName

protected void registerSoupUsingTableName()

Step 3: register soup with new indexes

copyTable

protected void copyTable()

Step 4: copy data from old soup table to new soup table

reIndexSoup

protected void reIndexSoup()

Step 5: re-index soup for new indexes (optional step)

dropOldTable

protected void dropOldTable()

Step 6: drop old soup table

createLongOperationDbRow

protected long createLongOperationDbRow()
                                 throws JSONException

Create row in long operations status table for a new alter soup operation

Returns:

Throws:

JSONException

getDetails

public JSONObject getDetails()
                      throws JSONException

Specified by:

getDetails in class LongOperation

Returns:

details as json (to be store in long operations table)

Throws:

JSONException

updateLongOperationDbRow

protected void updateLongOperationDbRow(AlterSoupLongOperation.AlterSoupStep newStatus)

Update row in long operations status table for on-going alter soup operation Delete row if newStatus is AlterStatus.LAST

Parameters:

newStatus -