org.jboss.aerogear.sync.diffmatchpatch.server

Class DiffMatchPatchServerSynchronizer

java.lang.Object

org.jboss.aerogear.sync.diffmatchpatch.server.DiffMatchPatchServerSynchronizer

All Implemented Interfaces:

ServerSynchronizer<String,DiffMatchPatchEdit>

public class DiffMatchPatchServerSynchronizer
extends Object
implements ServerSynchronizer<String,DiffMatchPatchEdit>

A ServerSynchronizer implementation that can handle text documents.

Constructor Summary

Constructors

Constructor and Description
DiffMatchPatchServerSynchronizer()
DiffMatchPatchServerSynchronizer(DiffMatchPatch diffMatchPatch)

Method Summary

Modifier and Type	Method and Description
DiffMatchPatchEdit	clientDiff(Document<String> document, ShadowDocument<String> shadowDocument) Is called to produce an Edit of changes coming from a client.
PatchMessage<DiffMatchPatchEdit>	createPatchMessage(String documentId, String clientId, Queue<DiffMatchPatchEdit> edits) Creates a new PatchMessage with the with the type of Edit that this synchronizer can handle.
Document<String>	documentFromJson(com.fasterxml.jackson.databind.JsonNode json) Converts the JsonNode into a Document instance.
Document<String>	patchDocument(DiffMatchPatchEdit edit, Document<String> document) Called when the document should be patched.
PatchMessage<DiffMatchPatchEdit>	patchMessageFromJson(String json) Creates a {link PatchMessage} by parsing the passed-in json.
ShadowDocument<String>	patchShadow(DiffMatchPatchEdit edit, ShadowDocument<String> shadowDocument) Called when the shadow should be patched.
DiffMatchPatchEdit	serverDiff(Document<String> document, ShadowDocument<String> shadowDocument) The first step in a sync is to produce a an edit for the changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffMatchPatchServerSynchronizer

public DiffMatchPatchServerSynchronizer()

DiffMatchPatchServerSynchronizer

public DiffMatchPatchServerSynchronizer(DiffMatchPatch diffMatchPatch)

Method Detail

clientDiff

public DiffMatchPatchEdit clientDiff(Document<String> document,
                                     ShadowDocument<String> shadowDocument)

Description copied from interface: ServerSynchronizer

Is called to produce an Edit of changes coming from a client.

Specified by:

clientDiff in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

document - the server side document .

shadowDocument - the document shadow containing the client changes.

Returns:

Edit the edit representing the diff between the document and it's shadow document.

serverDiff

public DiffMatchPatchEdit serverDiff(Document<String> document,
                                     ShadowDocument<String> shadowDocument)

Description copied from interface: ServerSynchronizer

The first step in a sync is to produce a an edit for the changes. The produced edit can then be sent to the opposing side perform an update/sync.

Specified by:

serverDiff in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

document - the document containing

shadowDocument - the document shadow.

Returns:

Edit the edit representing the diff between the document and it's shadow document.

patchShadow

public ShadowDocument<String> patchShadow(DiffMatchPatchEdit edit,
                                          ShadowDocument<String> shadowDocument)

Description copied from interface: ServerSynchronizer

Called when the shadow should be patched. Is called when an update is recieved.

Specified by:

patchShadow in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

edit - The edits.

shadowDocument - the ShadowDocument to patch

Returns:

ShadowDocument a new patched shadow document.

patchDocument

public Document<String> patchDocument(DiffMatchPatchEdit edit,
                                      Document<String> document)

Description copied from interface: ServerSynchronizer

Called when the document should be patched.

Specified by:

patchDocument in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

edit - the edit to use to path the document

document - the document to be patched.

Returns:

Document a new patched document.

createPatchMessage

public PatchMessage<DiffMatchPatchEdit> createPatchMessage(String documentId,
                                                           String clientId,
                                                           Queue<DiffMatchPatchEdit> edits)

Description copied from interface: ServerSynchronizer

Creates a new PatchMessage with the with the type of Edit that this synchronizer can handle.

Specified by:

createPatchMessage in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

documentId - the document identifier for the PatchMessage

clientId - the client identifier for the PatchMessage

edits - the Edits for the PatchMessage

Returns:

PatchMessage the created {code PatchMessage}

patchMessageFromJson

public PatchMessage<DiffMatchPatchEdit> patchMessageFromJson(String json)

Description copied from interface: ServerSynchronizer

Creates a {link PatchMessage} by parsing the passed-in json.

Specified by:

patchMessageFromJson in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

json - the json representation of a PatchMessage

Returns:

PatchMessage the created {code PatchMessage}

documentFromJson

public Document<String> documentFromJson(com.fasterxml.jackson.databind.JsonNode json)

Description copied from interface: ServerSynchronizer

Converts the JsonNode into a Document instance.

Specified by:

documentFromJson in interface ServerSynchronizer<String,DiffMatchPatchEdit>

Parameters:

json - the JsonNode to convert

Returns:

Document the document representing the contents of the JsonNode instance.