Package adams.flow.transformer.mongodbdocumentupdate

Interface MongoDbDocumentUpdate

All Superinterfaces:

adams.core.Destroyable, adams.flow.core.FlowContextHandler, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter

All Known Subinterfaces:

MongoDbDocumentAppend

All Known Implementing Classes:

AbstractAppend, AbstractMongoDbDocumentUpdate, Append, AppendStorage, AppendVariables, PassThrough, Remove

public interface MongoDbDocumentUpdate
extends adams.core.option.OptionHandler, adams.flow.core.FlowContextHandler, adams.core.QuickInfoSupporter

Interface for MongoDB document update schemes.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	update(com.mongodb.client.MongoCollection coll, org.bson.Document doc)	Updates the document.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Method Detail

update

String update(com.mongodb.client.MongoCollection coll,
              org.bson.Document doc)

Updates the document.

Parameters:

coll - the collection the document belongs to

doc - the document to update

Returns:

null if successful, otherwise the error message