com.couchbase.lite

Class QueryRow

java.lang.Object

com.couchbase.lite.QueryRow

public class QueryRow
extends java.lang.Object

A result row from a CouchbaseLite view query. Full-text and geo queries return subclasses -- see CBLFullTextQueryRow and CBLGeoQueryRow.

Constructor Summary

Constructors

Constructor and Description
QueryRow(java.lang.String docID, long sequence, java.lang.Object key, java.lang.Object value, RevisionInternal docRevision) Constructor The database property will be filled in when I'm added to a QueryEnumerator.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asJSONDictionary()
boolean	equals(java.lang.Object object) Compare this against the given QueryRow for equality.
java.util.List<SavedRevision>	getConflictingRevisions() Returns all conflicting revisions of the document, or nil if the document is not in conflict.
protected Database	getDatabase()
Document	getDocument() The document this row was mapped from.
java.lang.String	getDocumentId() The ID of the document described by this view row.
java.util.Map<java.lang.String,java.lang.Object>	getDocumentProperties() The properties of the document this row was mapped from.
java.lang.String	getDocumentRevisionId() The revision ID of the document this row was mapped from.
java.lang.Object	getKey() The row's key: this is the first parameter passed to the emit() call that generated the row.
long	getSequenceNumber() The local sequence number of the associated doc/revision.
java.lang.String	getSourceDocumentId() The ID of the document that caused this view row to be emitted.
java.lang.Object	getValue() The row's value: this is the second parameter passed to the emit() call that generated the row.
protected void	setDatabase(Database database)
java.lang.String	toString() Return a string representation of this QueryRow.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryRow

public QueryRow(java.lang.String docID,
                long sequence,
                java.lang.Object key,
                java.lang.Object value,
                RevisionInternal docRevision)

Constructor

The database property will be filled in when I'm added to a QueryEnumerator.

Method Detail

getDatabase

protected Database getDatabase()

setDatabase

protected void setDatabase(Database database)

getDocument

public Document getDocument()

The document this row was mapped from. This will be nil if a grouping was enabled in the query, because then the result rows don't correspond to individual documents.

getKey

public java.lang.Object getKey()

The row's key: this is the first parameter passed to the emit() call that generated the row.

getValue

public java.lang.Object getValue()

The row's value: this is the second parameter passed to the emit() call that generated the row.

getDocumentId

public java.lang.String getDocumentId()

The ID of the document described by this view row. This is not necessarily the same as the document that caused this row to be emitted; see the discussion of the .sourceDocumentID property for details.

getSourceDocumentId

public java.lang.String getSourceDocumentId()

The ID of the document that caused this view row to be emitted. This is the value of the "id" property of the JSON view row. It will be the same as the .documentID property, unless the map function caused a related document to be linked by adding an "_id" key to the emitted value; in this case .documentID will refer to the linked document, while sourceDocumentID always refers to the original document. In a reduced or grouped query the value will be nil, since the rows don't correspond to individual documents.

getDocumentRevisionId

public java.lang.String getDocumentRevisionId()

The revision ID of the document this row was mapped from.

getDocumentProperties

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

The properties of the document this row was mapped from. To get this, you must have set the -prefetch property on the query; else this will be nil. The map returned is immutable (run through Collections.unmodifiableMap)

getSequenceNumber

public long getSequenceNumber()

The local sequence number of the associated doc/revision.

getConflictingRevisions

public java.util.List<SavedRevision> getConflictingRevisions()

Returns all conflicting revisions of the document, or nil if the document is not in conflict.

The first object in the array will be the default "winning" revision that shadows the others. This is only valid in an allDocuments query whose allDocsMode is set to Query.AllDocsMode.SHOW_CONFLICTS or Query.AllDocsMode.ONLY_CONFLICTS; otherwise it returns an empty list.

equals

public boolean equals(java.lang.Object object)

Compare this against the given QueryRow for equality.

Implentation Note: This is used implicitly by -[LiveQuery update] to decide whether the query result has changed enough to notify the client. So it's important that it not give false positives, else the app won't get notified of changes.

Overrides:

equals in class java.lang.Object

Parameters:

object - the QueryRow to compare this instance with.

Returns:

true if equal, false otherwise.

toString

public java.lang.String toString()

Return a string representation of this QueryRow. The string is returned in JSON format.

Overrides:

toString in class java.lang.Object

Returns:

the JSON string representing this QueryRow

asJSONDictionary

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