com.cloudant.sync.datastore

Class ProjectedDocumentRevision

java.lang.Object

com.cloudant.sync.datastore.DocumentRevision

com.cloudant.sync.datastore.ProjectedDocumentRevision

All Implemented Interfaces:

java.lang.Comparable<DocumentRevision>

public class ProjectedDocumentRevision
extends DocumentRevision

A document revision that has been projected. This means that some fields may be missing when compared to the original copy of this revision. Use toFullRevision() to obtain a "full" revision with all fields present. This is a pre-requisite for saving a ProjectedDocumentRevision.

API Status: Public

Method Summary

Modifier and Type	Method and Description
DocumentRevision	toFullRevision() Returns a "Full" document revision.

Methods inherited from class com.cloudant.sync.datastore.DocumentRevision

asBytes, asMap, compareTo, equals, getAttachments, getBody, getGeneration, getId, getRevision, getSequence, hashCode, initialiseSequence, isBodyModified, isCurrent, isDeleted, isFullRevision, setAttachments, setBody, setDeleted, setRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

toFullRevision

public DocumentRevision toFullRevision()
                                throws DocumentNotFoundException

Description copied from class: DocumentRevision

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 DocumentRevision.isFullRevision() returns false.

Overrides:

toFullRevision in class DocumentRevision

Returns:

A "Full" document revision.

Throws:

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