org.jboss.aerogear.sync

Interface DataStore<T,S extends Edit<? extends Diff>>

Type Parameters:

T - The type of the Document that this data store can store.

S - The type of Edits that this data store can store

All Known Subinterfaces:

ClientDataStore<T,S>, ServerDataStore<T,S>

All Known Implementing Classes:

ClientInMemoryDataStore, ServerInMemoryDataStore

public interface DataStore<T,S extends Edit<? extends Diff>>

A DataStore implementation is responsible for storing and serving data for a Differential Synchronization implementation.

Method Summary

Modifier and Type	Method and Description
BackupShadowDocument<T>	getBackupShadowDocument(String documentId, String clientId) Retrieves the BackupShadowDocument matching the passed-in document documentId.
Queue<S>	getEdits(String documentId, String clientId) Retreives the queue of Edits for the specified document documentId.
ShadowDocument<T>	getShadowDocument(String documentId, String clientId) Retrieves the ShadowDocument matching the passed-in document documentId.
void	removeEdit(S edit, String documentId, String clientId) Removes the edit from the store.
void	removeEdits(String documentId, String clientId) Removes all edits for the specific client and document pair.
void	saveBackupShadowDocument(BackupShadowDocument<T> backupShadow) Saves a backup shadow document
void	saveEdits(S edit, String documentId, String clientId) Saves an Edit to the data store.
void	saveShadowDocument(ShadowDocument<T> shadowDocument) Saves a shadow document.

Method Detail

saveShadowDocument

void saveShadowDocument(ShadowDocument<T> shadowDocument)

Saves a shadow document.

Parameters:

shadowDocument - the ShadowDocument to save.

getShadowDocument

ShadowDocument<T> getShadowDocument(String documentId,
                                    String clientId)

Retrieves the ShadowDocument matching the passed-in document documentId.

Parameters:

documentId - the document id of the shadow document.

clientId - the client for which to retrieve the shadow document.

Returns:

ShadowDocument the shadow document matching the documentId.

saveBackupShadowDocument

void saveBackupShadowDocument(BackupShadowDocument<T> backupShadow)

Saves a backup shadow document

Parameters:

backupShadow - the BackupShadowDocument to save.

getBackupShadowDocument

BackupShadowDocument<T> getBackupShadowDocument(String documentId,
                                                String clientId)

Retrieves the BackupShadowDocument matching the passed-in document documentId.

Parameters:

documentId - the document identifier of the backup shadow document.

clientId - the client identifier for which to fetch the document.

Returns:

BackupShadowDocument the backup shadow document matching the documentId.

saveEdits

void saveEdits(S edit,
               String documentId,
               String clientId)

Saves an Edit to the data store.

Parameters:

edit - the edit to be saved.

documentId - the document identifier for the edit

clientId - the client identifier for the edit

getEdits

Queue<S> getEdits(String documentId,
                  String clientId)

Retreives the queue of Edits for the specified document documentId.

Parameters:

documentId - the document identifier of the edit.

clientId - the client identifier for which to fetch the document.

Returns:

Queue<S> the edits for the document.

removeEdit

void removeEdit(S edit,
                String documentId,
                String clientId)

Removes the edit from the store.

Parameters:

edit - the edit to be removed.

documentId - the document identifier for the edit

clientId - the client identifier for the edit

removeEdits

void removeEdits(String documentId,
                 String clientId)

Removes all edits for the specific client and document pair.

Parameters:

documentId - the document identifier of the edit.

clientId - the client identifier.