com.allanbank.mongodb.client.message

Class Delete

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Delete

All Implemented Interfaces:

Message

public class Delete
extends AbstractMessage

Message to delete documents from a collection. The format of the message is:

 
 struct {
     MsgHeader header;             // standard message header
     int32     ZERO;               // 0 - reserved for future use
     cstring   fullCollectionName; // "dbname.collectionname"
     int32     flags;              // bit vector - see below for details.
     document  selector;           // query object.  See below for details.
 }
 
 

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	SINGLE_DELETE_BIT The flag bit for performing a single delete only.

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

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Delete(BsonInputStream in) Create a new Delete message.
Delete(String databaseName, String collectionName, Document query, boolean singleDelete) Create a new Delete message.

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 Document.
int	hashCode() Computes a reasonable hash code.
boolean	isSingleDelete() Returns if only a single or all matching documents should be deleted.
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

SINGLE_DELETE_BIT

public static final int SINGLE_DELETE_BIT

The flag bit for performing a single delete only.

See Also:

Constant Field Values

Constructor Detail

Delete

public Delete(BsonInputStream in)
       throws IOException

Create a new Delete message.

Parameters:

in - The stream to read the delete message from.

Throws:

IOException - On a failure reading the delete message.

Delete

public Delete(String databaseName,
      String collectionName,
      Document query,
      boolean singleDelete)

Create a new Delete message.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection.

query - The query document for selecting documents to delete.

singleDelete - If true, only the first document found should be deleted, otherwise all matching documents should be deleted.

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: "DELETE".

Returns:

A short name for the operation.

getQuery

public Document getQuery()

Returns the query Document.

Returns:

The query Document.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

isSingleDelete

public boolean isSingleDelete()

Returns if only a single or all matching documents should be deleted.

Returns:

True if only the first document found will be deleted, otherwise all matching documents will be deleted.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the Delete.

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 query document is not too large.

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 a delete 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, com.allanbank.mongodb.bson.io.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 a delete 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, com.allanbank.mongodb.bson.io.BsonOutputStream)