com.cloudant.sync.datastore

Class DocumentRevision

java.lang.Object

com.cloudant.sync.datastore.DocumentRevision

All Implemented Interfaces:

java.lang.Comparable<DocumentRevision>

Direct Known Subclasses:

ProjectedDocumentRevision

public class DocumentRevision
extends java.lang.Object
implements java.lang.Comparable<DocumentRevision>

A single revision of a document within a datastore.

Documents within the datastore are in fact trees of document revisions, with one document marked as the current winner at any point. Branches in the tree are caused when a document is edited in more than one place before being replicated between datastores. The consuming application is responsible for finding active branches (also called conflicts), and marking the leaf nodes of all branches but one deleted (thereby resolving the conflict).

A DocumentRevision contains all the information for a single document revision, including its ID and revision ID, along with the document's content for this revision as a DocumentBody object. Clients will typically set only the revision content rather than the metadata explicitly.

API Status: Public

Constructor Summary

Constructors

Constructor and Description
DocumentRevision()
DocumentRevision(java.lang.String id)
DocumentRevision(java.lang.String id, java.lang.String revision)

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Returns the JSON body of the document revision as a byte array.
java.util.Map<java.lang.String,java.lang.Object>	asMap() Returns the JSON body of the document revision as a Map object.
int	compareTo(DocumentRevision o)
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,Attachment>	getAttachments() top level key: _attachments
DocumentBody	getBody() the rest of the document
int	getGeneration()
java.lang.String	getId()
java.lang.String	getRevision()
long	getSequence() Returns the sequence number of this revision.
int	hashCode()
void	initialiseSequence(long sequence)
boolean	isCurrent()
boolean	isDeleted()
boolean	isFullRevision() Returns true if this revision is a full revision.
void	setAttachments(java.util.Map<java.lang.String,Attachment> attachments)
void	setBody(DocumentBody body)
void	setDeleted(boolean deleted)
void	setRevision(java.lang.String revision)
DocumentRevision	toFullRevision() Returns a "Full" document revision.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentRevision

public DocumentRevision()

DocumentRevision

public DocumentRevision(java.lang.String id)

DocumentRevision

public DocumentRevision(java.lang.String id,
                        java.lang.String revision)

Method Detail

getId

public java.lang.String getId()

Returns:

the unique identifier of the document

getRevision

public java.lang.String getRevision()

Returns:

the revision ID of this document revision

getBody

public DocumentBody getBody()

the rest of the document

setBody

public void setBody(DocumentBody body)

getAttachments

public java.util.Map<java.lang.String,Attachment> getAttachments()

top level key: _attachments

setAttachments

public void setAttachments(java.util.Map<java.lang.String,Attachment> attachments)

isDeleted

public boolean isDeleted()

Returns:

true if this revision is marked deleted.

isFullRevision

public boolean isFullRevision()

Returns true if this revision is a full revision. A full revision is a revision which contains all the data related to the revision. For example revisions returned from Query where only select fields have been included is not regarded as a full revision.

Returns:

true if this revision is a full revision.

toFullRevision

public DocumentRevision toFullRevision()
                                throws DocumentNotFoundException

Returns a "Full" document revision. A full document revision is a revision which contains all the information associated with it. For example when a document is returned from IndexManager.find(Map, long, long, List, List) using the fields option to limit the fields returned, a revision will be missing data so it cannot be regarded as a full revision. If the document is a full revision, this method will only attempt to load the full revision from the datastore if isFullRevision() returns false.

Returns:

A "Full" document revision.

Throws:

DocumentNotFoundException - Thrown if the full document cannot be loaded from the datastore.

setRevision

public void setRevision(java.lang.String revision)

isCurrent

public boolean isCurrent()

Returns:

true if this revision is the current winner for the document.

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()

Returns the JSON body of the document revision as a Map object.

This Map includes reserved fields such as _id and _rev. Changing the byte array may affect the DocumentRevision, as only a shallow copy is returned.

Returns:

the JSON body of the document revision as a Map object.

asBytes

public byte[] asBytes()

Returns the JSON body of the document revision as a byte array.

This byte array includes reserved fields such as _id and _rev. Changing the byte array does not affect the document revisions contents.

Returns:

the JSON body of the document revision as a byte array.

setDeleted

public void setDeleted(boolean deleted)

getSequence

public long getSequence()

Returns the sequence number of this revision.

The sequence number is unique across the database, it is updated for every modification to the datastore.

Returns:

the sequence number of this revision.

initialiseSequence

public void initialiseSequence(long sequence)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGeneration

public int getGeneration()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(DocumentRevision o)

Specified by:

compareTo in interface java.lang.Comparable<DocumentRevision>