com.allanbank.mongodb.client.message

Class Update

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Update

All Implemented Interfaces:

Message

public class Update
extends AbstractMessage

Message to apply an update to a document.

 
 struct OP_UPDATE {
     MsgHeader header;             // standard message header
     int32     ZERO;               // 0 - reserved for future use
     cstring   fullCollectionName; // "dbname.collectionname"
     int32     flags;              // bit vector. see below
     document  selector;           // the query to select the document
     document  update;             // specification of the update to perform
 }
 
 

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static int	MULTIUPDATE_FLAG_BIT Flag bit for a multi-update.
static int	UPSERT_FLAG_BIT Flag bit for an upsert.

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Update(BsonInputStream in) Creates a new Update.
Update(String databaseName, String collectionName, Document query, Document update, boolean multiUpdate, boolean upsert) Creates a new Update.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
String	getOperationName() Returns a short name for the operation.
Document	getQuery() Returns the query to select the document to update.
Document	getUpdate() Returns the updates to apply to the selected document(s).
int	hashCode() Computes a reasonable hash code.
boolean	isMultiUpdate() Returns true if all documents matching the query should be updated, otherwise only the first document should be updated.
boolean	isUpsert() Returns true if the document should be inserted if none match the query criteria.
int	size() Returns the total size of the message on the wire.
void	validateSize(int maxDocumentSize) Validates that the documents with the message do not exceed the maximum document size specified.
void	write(int messageId, BsonOutputStream out) Writes the message from the stream.
void	write(int messageId, BufferingBsonOutputStream out) Writes the message from the stream.

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

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

Field Detail

MULTIUPDATE_FLAG_BIT

public static final int MULTIUPDATE_FLAG_BIT

Flag bit for a multi-update.

See Also:

Constant Field Values

UPSERT_FLAG_BIT

public static final int UPSERT_FLAG_BIT

Flag bit for an upsert.

See Also:

Constant Field Values

Constructor Detail

Update

public Update(BsonInputStream in)
       throws IOException

Creates a new Update.

Parameters:

in - The input stream to read the update message from.

Throws:

IOException - On an error reading the update message.

Update

public Update(String databaseName,
      String collectionName,
      Document query,
      Document update,
      boolean multiUpdate,
      boolean upsert)

Creates a new Update.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection.

query - The query to select the document to update.

update - The updates to apply to the selected document(s).

multiUpdate - If true then all documents matching the query should be updated, otherwise only the first document should be updated.

upsert - If true then a document should be inserted if none match the query criteria.

Method Detail

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class AbstractMessage

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getOperationName

public String getOperationName()

Returns a short name for the operation.

Overridden to return the name of the operation: "UPDATE".

Returns:

A short name for the operation.

getQuery

public Document getQuery()

Returns the query to select the document to update.

Returns:

The query to select the document to update.

getUpdate

public Document getUpdate()

Returns the updates to apply to the selected document(s).

Returns:

The updates to apply to the selected document(s).

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

isMultiUpdate

public boolean isMultiUpdate()

Returns true if all documents matching the query should be updated, otherwise only the first document should be updated.

Returns:

True if all documents matching the query should be updated, otherwise only the first document should be updated.

isUpsert

public boolean isUpsert()

Returns true if the document should be inserted if none match the query criteria.

Returns:

True if the document should be inserted if none match the query criteria.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the Query.

Returns:

The size of the message on the wire.

validateSize

public void validateSize(int maxDocumentSize)
                  throws DocumentToLargeException

Validates that the documents with the message do not exceed the maximum document size specified.

Overridden to ensure the inserted documents are not too large in aggregate.

Parameters:

maxDocumentSize - The maximum document size to validate against.

Throws:

DocumentToLargeException - If one of the documents in the message is too large or the documents in aggregate are too large.

write

public void write(int messageId,
         BsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write the update message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)

write

public void write(int messageId,
         BufferingBsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write the update message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)