com.allanbank.mongodb.builder

Class BatchedWrite.Builder

java.lang.Object

com.allanbank.mongodb.builder.BatchedWrite.Builder

Enclosing class:

BatchedWrite

public static class BatchedWrite.Builder
extends Object

Builder for creating BatchedWrites.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Durability	myDurability The durability for the writes.
protected BatchedWriteMode	myMode The mode for submitting the writes to the server.
protected List<WriteOperation>	myWrites The writes to submit to the server.

Constructor Summary

Constructors

Constructor and Description
BatchedWrite.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
BatchedWrite	build() Constructs a new BatchedWrite object from the state of the builder.
BatchedWrite.Builder	delete(DocumentAssignable query) Update a document based on a query.
BatchedWrite.Builder	delete(DocumentAssignable query, boolean singleDelete) Update a document based on a query.
BatchedWrite.Builder	durability(Durability durability) Sets the durability for the writes.
Durability	getDurability() Returns the durability for the write.
BatchedWrite.Builder	insert(DocumentAssignable document) Adds an insert operation to the batched write.
BatchedWrite.Builder	mode(BatchedWriteMode mode) Sets the mode for submitting the writes to the server.
BatchedWrite.Builder	reset() Resets the builder back to its initial state for reuse.
BatchedWrite.Builder	save(DocumentAssignable document) Saves the document to MongoDB.
BatchedWrite.Builder	setDurability(Durability durability) Sets the durability for the writes.
BatchedWrite.Builder	setMode(BatchedWriteMode mode) Sets the mode for submitting the writes to the server.
BatchedWrite.Builder	setWrites(List<WriteOperation> writes) Sets the writes to submit to the server.
BatchedWrite.Builder	update(DocumentAssignable query, DocumentAssignable update) Update a document based on a query.
BatchedWrite.Builder	update(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert) Update a document based on a query.
BatchedWrite.Builder	write(WriteOperation write) Adds a single write to the list of writes to send to the server.
BatchedWrite.Builder	writes(List<WriteOperation> writes) Sets the writes to submit to the server.

Methods inherited from class java.lang.Object

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

Field Detail

myDurability

protected Durability myDurability

The durability for the writes.

myMode

protected BatchedWriteMode myMode

The mode for submitting the writes to the server.

myWrites

protected final List<WriteOperation> myWrites

The writes to submit to the server.

Constructor Detail

BatchedWrite.Builder

public BatchedWrite.Builder()

Creates a new Builder.

Method Detail

build

public BatchedWrite build()

Constructs a new BatchedWrite object from the state of the builder.

Returns:

The new BatchedWrite object.

delete

public BatchedWrite.Builder delete(DocumentAssignable query)

Update a document based on a query.

Defaults to deleting as many documents as match the query.

This method is delegates to delete(query, false)

Parameters:

query - The query to find the document to delete.

Returns:

This builder for chaining method calls.

delete

public BatchedWrite.Builder delete(DocumentAssignable query,
                          boolean singleDelete)

Update a document based on a query.

Defaults to deleting as many documents as match the query.

Parameters:

query - The query to find the document to delete.

singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.

Returns:

This builder for chaining method calls.

durability

public BatchedWrite.Builder durability(Durability durability)

Sets the durability for the writes.

This method delegates to setDurability(Durability).

Parameters:

durability - The new value for the durability for the writes.

Returns:

This builder for chaining method calls.

getDurability

public Durability getDurability()

Returns the durability for the write.

Returns:

This durability for the write.

insert

public BatchedWrite.Builder insert(DocumentAssignable document)

Adds an insert operation to the batched write.

Parameters:

document - The document to insert.

Returns:

This builder for chaining method calls.

mode

public BatchedWrite.Builder mode(BatchedWriteMode mode)

Sets the mode for submitting the writes to the server.

This method delegates to setMode(BatchedWriteMode).

Parameters:

mode - The new value for the mode for submitting the writes to the server.

Returns:

This builder for chaining method calls.

reset

public BatchedWrite.Builder reset()

Resets the builder back to its initial state for reuse.

Returns:

This builder for chaining method calls.

save

public BatchedWrite.Builder save(DocumentAssignable document)

Saves the document to MongoDB.

If the document does not contain an _id field then this method is equivalent to: insert(document).

If the document does contain an _id field then this method is equivalent to: updateAsync(BuilderFactory.start().add(document.get("_id")), document, false, true).

Parameters:

document - The document to save.

Returns:

This builder for chaining method calls.

setDurability

public BatchedWrite.Builder setDurability(Durability durability)

Sets the durability for the writes.

Parameters:

durability - The new value for the durability for the writes.

Returns:

This builder for chaining method calls.

setMode

public BatchedWrite.Builder setMode(BatchedWriteMode mode)

Sets the mode for submitting the writes to the server.

Parameters:

mode - The new value for the mode for submitting the writes to the server.

Returns:

This builder for chaining method calls.

setWrites

public BatchedWrite.Builder setWrites(List<WriteOperation> writes)

Sets the writes to submit to the server.

Parameters:

writes - The new value for the writes to submit to the server.

Returns:

This builder for chaining method calls.

update

public BatchedWrite.Builder update(DocumentAssignable query,
                          DocumentAssignable update)

Update a document based on a query.

Defaults to updating a single document and not performing an upsert if no document is found.

This method is delegates to update(query, update, false, false)

Parameters:

query - The query to find the document to update.

update - The update operations to apply to the document.

Returns:

This builder for chaining method calls.

update

public BatchedWrite.Builder update(DocumentAssignable query,
                          DocumentAssignable update,
                          boolean multiUpdate,
                          boolean upsert)

Update a document based on a query.

Defaults to updating a single document and not performing an upsert if no document is found.

Parameters:

query - The query to find the document to update.

update - The update operations to apply to the document.

multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.

upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.

Returns:

This builder for chaining method calls.

write

public BatchedWrite.Builder write(WriteOperation write)

Adds a single write to the list of writes to send to the server.

Parameters:

write - The write to add to the list of writes to send to the server.

Returns:

This builder for chaining method calls.

writes

public BatchedWrite.Builder writes(List<WriteOperation> writes)

Sets the writes to submit to the server.

This method delegates to setWrites(List).

Parameters:

writes - The new value for the writes to submit to the server.

Returns:

This builder for chaining method calls.