com.allanbank.mongodb.client.message

Class Insert

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Insert

All Implemented Interfaces:

Message

public class Insert
extends AbstractMessage

Message to insert a set of documents into a collection.

 
 struct {
     MsgHeader header;             // standard message header
     int32     flags;              // bit vector - see below
     cstring   fullCollectionName; // "dbname.collectionname"
     document* documents;          // one or more documents to insert into the collection
 }
 
 

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	CONTINUE_ON_ERROR_BIT The flag bit to keep inserting documents on an error.

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

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Insert(Header header, BsonInputStream in) Creates a new Insert.
Insert(String databaseName, String collectionName, List<Document> documents, boolean continueOnError) Creates a new Insert.
Insert(String databaseName, String collectionName, List<Document> documents, boolean continueOnError, VersionRange requiredServerVersion) Creates a new Insert.

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.
List<Document>	getDocuments() Returns the documents to insert.
String	getOperationName() Returns a short name for the operation.
int	hashCode() Computes a reasonable hash code.
boolean	isContinueOnError() Returns true if the insert should continue with other documents if one of the document inserts encounters an error.
int	size() Returns the total size of the message on the wire.
String	toString()
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, wait, wait, wait

Field Detail

CONTINUE_ON_ERROR_BIT

public static final int CONTINUE_ON_ERROR_BIT

The flag bit to keep inserting documents on an error.

See Also:

Constant Field Values

Constructor Detail

Insert

public Insert(Header header,
      BsonInputStream in)
       throws IOException

Creates a new Insert.

Parameters:

header - The header proceeding the insert message. This is used to locate the end of the insert.

in - The stream to read the insert message from.

Throws:

IOException - On a failure reading the insert message.

Insert

public Insert(String databaseName,
      String collectionName,
      List<Document> documents,
      boolean continueOnError)

Creates a new Insert.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection.

documents - The documents to be inserted.

continueOnError - If the insert should continue if one of the documents causes an error.

Insert

public Insert(String databaseName,
      String collectionName,
      List<Document> documents,
      boolean continueOnError,
      VersionRange requiredServerVersion)

Creates a new Insert.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection.

documents - The documents to be inserted.

continueOnError - If the insert should continue if one of the documents causes an error.

requiredServerVersion - The required version of the server to support processing the message.

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)

getDocuments

public List<Document> getDocuments()

Returns the documents to insert.

Returns:

The documents to insert.

getOperationName

public String getOperationName()

Returns a short name for the operation.

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

Returns:

A short name for the operation.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

isContinueOnError

public boolean isContinueOnError()

Returns true if the insert should continue with other documents if one of the document inserts encounters an error.

Returns:

True if the insert should continue with other documents if one of the document inserts encounters an error.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the Insert.

Returns:

The size of the message on the wire.

toString

public String toString()

Overridden to output the documents and insert flags.

Overrides:

toString in class Object

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 insert 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 insert 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)